diff options
| author | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
|---|---|---|
| committer | Zhineng Li <im@zhineng.li> | 2026-07-12 17:11:17 +0800 |
| commit | 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch) | |
| tree | 5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/dyvmsapi | |
| parent | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff) | |
| download | afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip | |
update APIs 20260712
Diffstat (limited to 'data/zh_cn/dyvmsapi')
| -rw-r--r-- | data/zh_cn/dyvmsapi/2017-05-25/api-docs.php | 17942 |
1 files changed, 12237 insertions, 5705 deletions
diff --git a/data/zh_cn/dyvmsapi/2017-05-25/api-docs.php b/data/zh_cn/dyvmsapi/2017-05-25/api-docs.php index 0d6fa2b..9527318 100644 --- a/data/zh_cn/dyvmsapi/2017-05-25/api-docs.php +++ b/data/zh_cn/dyvmsapi/2017-05-25/api-docs.php @@ -1,175 +1,158 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'Dyvmsapi', - 'version' => '2017-05-25', - ], + 'info' => ['style' => 'RPC', 'product' => 'Dyvmsapi', 'version' => '2017-05-25'], 'directories' => [ [ - 'id' => 141310, - 'title' => '发送语音通知', - 'type' => 'directory', 'children' => [ - 'SingleCallByVoice', + [ + 'children' => [ + [ + 'children' => ['CloudQueryTask', 'CloudMonitorTask', 'CloudPauseTask', 'CloudListTaskFile', 'CloudGetTask', 'CloudDeleteTaskTel', 'CloudDeleteTask', 'CloudCreateTask', 'CloudImportTaskTel', 'CloudStartTask', 'CloudUpdateTask'], + 'type' => 'directory', + 'title' => '呼叫任务接口', + 'id' => 449062, + ], + [ + 'children' => ['CloudUnassignAgentGroup', 'CloudAgentMonitorStatistics', 'CloudQueryAgentSkill', 'CloudQueryAgentGroup', 'CloudQueryAgent', 'CloudListAgentTel', 'CloudGetAgentStatus', 'CloudBatchUpdateAgent', 'CloudUpdateAgent', 'CloudQueryAgentCnoAndName', 'CloudListOnlineAgent', 'CloudListFreeAgent', 'CloudGetAgent', 'CloudDeleteAgentTel', 'CloudDeleteAgent', 'CloudBatchGetAgentStatus', 'CloudBatchCreateAgent', 'CloudCreateAgent'], + 'type' => 'directory', + 'title' => '座席管理接口', + 'id' => 449063, + ], + [ + 'children' => ['CloudWebcall', 'CloudPreviewoutcall', 'CloudInterruptIvr', 'CloudAgentUnlink', 'CloudAgentSetUserData', 'CloudAgentLogin', 'CloudAgentLogout'], + 'type' => 'directory', + 'title' => '座席Action接口', + 'id' => 449064, + ], + [ + 'children' => [ + 'CloudListSkill', 'CloudListQueueSkill', 'CloudListQueue', 'CloudListExten', 'CloudListAssignedAgentGroup', 'CloudListAgentGroup', 'CloudDeleteQueueSkill', 'CloudGetQueue', 'CloudGetExten', 'CloudDeleteSkill', 'CloudDeleteQueue', 'CloudDeleteExten', 'CloudDeleteEnterpriseTime', 'CloudDeleteAgentGroup', 'CloudCreateSkill', 'CloudCreateQueueSkill', 'CloudCreateQueue', 'CloudCreateExten', 'CloudCreateEnterpriseTime', 'CloudCreateAgentGroup', + 'CloudAssignAgentGroup', + ], + 'type' => 'directory', + 'title' => '呼叫配置管理', + 'id' => 449065, + ], + [ + 'children' => ['CloudListCurlLog'], + 'type' => 'directory', + 'title' => '日志', + 'id' => 449066, + ], + [ + 'children' => ['CloudQueryWebcallCdr', 'CloudQueryPredictiveCallCdr', 'CloudQueryObCdr', 'CloudQueryIbCdr', 'CloudOutboundPreviewObReport', 'CloudOutboundObClidReport', 'CloudGetRecordUrl', 'CloudGetObCdr', 'CloudCreateAsr'], + 'type' => 'directory', + 'title' => '通话记录', + 'id' => 449067, + ], + [ + 'children' => ['CloudAgentWorkloadReport', 'CloudQueryRasrEvent', 'CloudGetAsr', 'CloudGetAreaCode'], + 'type' => 'directory', + 'title' => '其他', + 'id' => 449068, + ], + ], + 'type' => 'directory', + 'title' => 'Cloud平台', + 'id' => 449061, + ], ], + 'type' => 'directory', + 'title' => '行业云联络中心', + 'id' => 449028, ], [ - 'id' => 141312, - 'title' => '发送语音验证码', + 'children' => ['SingleCallByVoice'], 'type' => 'directory', - 'children' => [ - 'SingleCallByTts', - ], + 'title' => '发送语音通知', + 'id' => 449069, ], [ - 'id' => 141318, - 'title' => '语音通话任务', + 'children' => ['SingleCallByTts'], 'type' => 'directory', - 'children' => [ - 'CreateCallTask', - 'ListCallTask', - 'ExecuteCallTask', - 'ListCallTaskDetail', - ], + 'title' => '发送语音验证码', + 'id' => 449070, ], [ - 'id' => 141314, - 'title' => '服务实例', + 'children' => ['CreateCallTask', 'ListCallTask', 'ExecuteCallTask', 'ListCallTaskDetail'], 'type' => 'directory', - 'children' => [ - 'AddVirtualNumberRelation', - 'QueryVirtualNumberRelation', - 'ListServiceInstanceForPage', - ], + 'title' => '语音通话任务', + 'id' => 449071, ], [ - 'id' => 141360, - 'title' => '查询语音文件审核状态', + 'children' => ['AddVirtualNumberRelation', 'QueryVirtualNumberRelation', 'ListServiceInstanceForPage'], 'type' => 'directory', - 'children' => [ - 'QueryVoiceFileAuditInfo', - ], + 'title' => '服务实例', + 'id' => 449072, ], [ - 'id' => 141331, - 'title' => '查询呼叫详情', + 'children' => ['QueryVoiceFileAuditInfo'], 'type' => 'directory', - 'children' => [ - 'QueryCallDetailByCallId', - ], + 'title' => '查询语音文件审核状态', + 'id' => 449073, ], [ - 'id' => 141323, - 'title' => '交互式语音通话', + 'children' => ['QueryCallDetailByCallId'], 'type' => 'directory', - 'children' => [ - 'IvrCall', - ], + 'title' => '查询呼叫详情', + 'id' => 449074, ], [ - 'id' => 141328, - 'title' => '智能语音交互通话', + 'children' => ['IvrCall'], 'type' => 'directory', - 'children' => [ - 'SmartCall', - 'SmartCallOperate', - ], + 'title' => '交互式语音通话', + 'id' => 449075, ], [ - 'id' => 141333, - 'title' => '智能语音机器人', + 'children' => ['SmartCall', 'SmartCallOperate'], 'type' => 'directory', - 'children' => [ - 'CreateRobotTask', - 'BatchRobotSmartCall', - 'StartRobotTask', - 'StopRobotTask', - 'CancelOrderRobotTask', - 'CancelRobotTask', - 'DeleteRobotTask', - 'QueryRobotv2AllList', - 'QueryRobotTaskList', - 'QueryCallDetailByTaskId', - 'QueryRobotTaskDetail', - 'QueryRobotTaskCallList', - 'QueryRobotInfoList', - 'QueryRobotTaskCallDetail', - 'UploadRobotTaskCalledFile', - ], + 'title' => '智能语音交互通话', + 'id' => 449076, ], [ - 'id' => 141349, - 'title' => '400号码', + 'children' => ['CreateRobotTask', 'BatchRobotSmartCall', 'StartRobotTask', 'StopRobotTask', 'CancelOrderRobotTask', 'CancelRobotTask', 'DeleteRobotTask', 'QueryRobotv2AllList', 'QueryRobotTaskList', 'QueryCallDetailByTaskId', 'QueryRobotTaskDetail', 'QueryRobotTaskCallList', 'QueryRobotInfoList', 'QueryRobotTaskCallDetail', 'UploadRobotTaskCalledFile'], 'type' => 'directory', - 'children' => [ - 'GetHotlineQualificationByOrder', - 'ListHotlineTransferRegisterFile', - 'SubmitHotlineTransferRegister', - 'SetTransferCalleePoolConfig', - 'QueryCallInPoolTransferConfig', - 'QueryCallInTransferRecord', - 'SendVerification', - ], + 'title' => '智能语音机器人', + 'id' => 449077, ], [ - 'id' => 191750, - 'title' => '5G视频通话（邀约制）', + 'children' => ['GetHotlineQualificationByOrder', 'ListHotlineTransferRegisterFile', 'SubmitHotlineTransferRegister', 'SetTransferCalleePoolConfig', 'QueryCallInPoolTransferConfig', 'QueryCallInTransferRecord', 'SendVerification'], 'type' => 'directory', - 'children' => [ - 'SingleCallByVideo', - 'PlayVideoFile', - 'PauseVideoFile', - 'ResumeVideoFile', - 'QueryVideoPlayProgress', - 'UpgradeVideoFile', - 'DegradeVideoFile', - 'SkipVideoFile', - 'GetCallMediaType', - 'GetTemporaryFileUrl', - ], + 'title' => '400号码', + 'id' => 449078, ], [ - 'id' => 141358, - 'title' => '获取认证Token', + 'children' => ['SingleCallByVideo', 'PlayVideoFile', 'PauseVideoFile', 'ResumeVideoFile', 'QueryVideoPlayProgress', 'UpgradeVideoFile', 'DegradeVideoFile', 'SkipVideoFile', 'GetCallMediaType', 'GetTemporaryFileUrl'], 'type' => 'directory', - 'children' => [ - 'GetToken', - ], + 'title' => '5G视频通话（邀约制）', + 'id' => 449079, ], [ - 'id' => 166959, - 'title' => '400号码呼转设置', + 'children' => ['GetToken'], 'type' => 'directory', - 'children' => [ - 'RecoverCallInConfig', - 'StopCallInConfig', - ], + 'title' => '获取认证Token', + 'id' => 449080, ], [ - 'id' => 362618, - 'title' => '其他', + 'children' => ['RecoverCallInConfig', 'StopCallInConfig'], 'type' => 'directory', - 'children' => [ - 'CancelCall', - 'QueryVmsVirtualNumberRelationByPage', - 'QueryVmsRealNumberCallConnectionRateInfo', - ], + 'title' => '400号码呼转设置', + 'id' => 449081, + ], + [ + 'children' => ['CancelCall', 'QueryVmsVirtualNumberRelationByPage', 'QueryVmsRealNumberCallConnectionRateInfo'], + 'type' => 'directory', + 'title' => '其他', + 'id' => 449082, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'SingleCallByVoice' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddVirtualNumberRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -180,107 +163,185 @@ 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52712', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '52666', + 'abilityTreeNodes' => ['FEATUREdyvmsT3BNLH'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'ProdCode', 'in' => 'query', + 'schema' => ['description' => '产品名称。默认取值：**dyvms**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dyvms', 'default' => 'dyvmsapi'], + ], + [ + 'name' => 'CorpNameList', + 'in' => 'query', + 'schema' => ['description' => '公司名列表。多个公司之间用半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '公司1,公司2'], + ], + [ + 'name' => 'NumberList', + 'in' => 'query', + 'schema' => ['description' => '真实号码列表。多个号码之间使用半角逗号（,）分隔。 您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的真实号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1321111****,1322222****'], + ], + [ + 'name' => 'RouteType', + 'in' => 'query', + 'schema' => ['description' => '路由类型。取值：'."\n" + ."\n" + .'- **0**：归属地优先。'."\n" + .'- **1**：随机。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '99999', 'minimum' => '0', 'example' => '0'], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => '服务实例ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)，在**服务实例管理**页面查看已申请的服务实例。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '05516214****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发送语音通知的通话号码（被叫显号）。若此参数不填，则为公共模式通话；若传入真实号或服务实例ID，则为专属模式通话。'."\n" - ."\n" - .'- 如果您使用公共模式通话，该参数不填。将由系统随机调度使用公共号码池内的号码通话。'."\n" - .'- 如果您使用专属模式通话，请传入您的**真实号码**或**服务实例ID**。'."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**服务实例管理**页面查看已创建并绑定真实号的**服务实例**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回200代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'successful'], + 'Data' => ['description' => '返回关联失败号码列表。'."\n" + ."\n" + .'> 如果全部关联成功，此参数不返回。', 'type' => 'string', 'example' => '1321111****'], + 'RequestId' => ['description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You have not been authorized.', 'description' => '未开通权限'], + ], + 500 => [ + ['errorCode' => 'VirtualNumber.Query.Fail', 'errorMessage' => 'Query virtual number fail.', 'description' => ''], + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to backend service exception.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"1321111****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<AddVirtualNumberRelationResponse>\\n<RequestId>B0411112-6CF8-4752-81D1-918A1354AE49</RequestId>\\n<Message>successful</Message>\\n<Data>1321111*****</Data>\\n<Code>200</Code>\\n</AddVirtualNumberRelationResponse>","errorExample":""}]', + 'title' => '批量添加服务实例与真实号码绑定关系', + 'summary' => '批量添加服务实例与真实号码绑定关系。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：200次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddVirtualNumberRelation'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:AddVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'BatchRobotSmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => '被叫显号，必须是已购买的号码。您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)查看已购买的号码。'."\n" + ."\n" + .'支持设置1~100个被叫显号，号码之间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '136****0000,138****0000'], + ], + [ + 'name' => 'CorpName', + 'in' => 'query', + 'schema' => ['description' => '公司名称，必须和[资质管理页面](https://dyvms.console.aliyun.com/dyvms.htm#/corp/normal)中的**公司名称**完全一致。'."\n" + ."\n" + .'> 如果开通了**自有线路**功能，即**isSelfLine**为**true**时，该参数为可选。反之则必须填写公司名称。', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴通信技术（北京）有限公司 '], + ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '接收语音通知的被叫号码。'."\n" - ."\n" - .'号码格式：'."\n" - .'- 手机号码。示例：159****0000。'."\n" - .'- 固话号码。示例：0571****5678。'."\n" - .'> - 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n" - .'> - 同一个**资质信息+号码用途**，拨打每一个被叫号码的频次有流控限制：1次/分钟、5次/小时、20次/24小时。 流控规则计时从第一次正常外呼开始，超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。'."\n" - .'> - 如**使用专属模式**调用此接口且您的业务需要更宽松的流控频率，您可至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)--通用设置--呼叫设置--呼出流控-频次中，尝试**申请调整流控次数**，**公共模式不支持**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => '被叫号码。仅支持中国大陆号码。'."\n" + ."\n" + .'支持设置1~1000个被叫号码，号码之间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '1390000****'], ], [ - 'name' => 'VoiceCode', + 'name' => 'DialogId', 'in' => 'query', - 'schema' => [ - 'description' => '语音通知文件的语音ID。传入的语音ID的外呼模式类型应与CalledShowNumber匹配。'."\n" - ."\n" - .'您可登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)在以下页面获取语音ID，该语音通知文件必须已审核通过。'."\n" - ."\n" - .'- 在**语音消息**>**语音通知**>**语音通知文件**页面获取**语音ID**。'."\n" - ."\n" - .'- 在**语音文件管理**>**语音通知文件**页面获取**语音ID**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - ], + 'schema' => ['description' => '指定机器人ID，即话术ID。表示选择哪个机器人/话术发起呼叫。'."\n" + ."\n" + .'请在[话术管理页面](https://dyvms.console.aliyun.com/patter/list)中查看**话术ID**。', 'type' => 'string', 'required' => true, 'example' => '100002970****'], ], [ - 'name' => 'PlayTimes', + 'name' => 'EarlyMediaAsr', 'in' => 'query', - 'schema' => [ - 'description' => '语音通知文件的播放次数。取值范围：**1~3**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '早媒体语音识别标识。默认为**false**，即不启用。'."\n" + ."\n" + .'如果需要启用早媒体语音识别标识，请设置为**true**。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'Volume', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => '语音通知文件播放的音量。取值范围：**0~100**，默认取值**100**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '任务名称。'."\n" + ."\n" + .'- 支持中文和英文。'."\n" + ."\n" + .'- 长度限制为：0~30个字符。', 'type' => 'string', 'required' => true, 'example' => '批量外呼任务 '], ], [ - 'name' => 'Speed', + 'name' => 'ScheduleTime', 'in' => 'query', - 'schema' => [ - 'description' => '语音文件播放的语速。取值范围：**-500~500**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '预设的呼叫时间。Unix时间戳格式，单位为毫秒。'."\n" + ."\n" + .'> 当参数**ScheduleCall**为**true**时必选。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12'], ], [ - 'name' => 'OutId', + 'name' => 'ScheduleCall', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度限制为1~15个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '22596****', - ], + 'schema' => ['description' => '是否定时呼叫。如果设置为**true**，则必须设置**ScheduleTime**。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => ['description' => 'TTS模板的变量值，格式为JSON。'."\n" + ."\n" + .'必须和具体的号码对应，TtsParam与TtsParamHead变量名称一一对应。', 'type' => 'string', 'required' => false, 'example' => '[{"number":"1390000****","params":[“小王”,"小李","小周"]}]'], + ], + [ + 'name' => 'TtsParamHead', + 'in' => 'query', + 'schema' => ['description' => '带变量的呼叫任务，格式为JSON。'."\n" + ."\n" + .'变量名称列表，与TtsParam配合使用。', 'type' => 'string', 'required' => false, 'example' => '["name1","name2","name3"]'], + ], + [ + 'name' => 'IsSelfLine', + 'in' => 'query', + 'schema' => ['description' => '是否调用自有线路，默认为**false**，即不调用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -289,752 +350,1008 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回**OK**代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E50FFA85-0B79-4421-A7BD-00B0A271966F', - ], - 'CallId' => [ - 'description' => '此次通话的唯一回执ID。'."\n" - ."\n" - .'可以使用此CallId，调用[QueryCallDetailByCallId](~~393529~~)接口查询指定通话详情。', - 'type' => 'string', - 'example' => '116004767703^102806****', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'TaskId' => ['description' => '机器人呼叫任务的唯一任务ID，可以通过此ID调用[QueryCallDetailByTaskId](~~393537~~)接口查询任务详情。', 'type' => 'string', 'example' => '4001112222'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E50FFA85-0B79-4421-A7BD-00B0A271966F\\",\\n \\"CallId\\": \\"116004767703^102806****\\"\\n}","type":"json"}]', - 'title' => '发送语音通知文件类型的语音通知', - 'summary' => '调用接口给单个被叫号码发送语音通知文件类型的语音通知。', - 'description' => '- 请在使用该接口前，了解语音服务套餐包及功能计费，详情请参见[国内语音服务定价](~~150083~~)。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"TaskId\\": \\"4001112222\\"\\n}","type":"json"}]', + 'title' => '批量发起智能语音机器人外呼任务', + 'summary' => '批量发起智能语音机器人外呼任务，一次任务支持设置1~100个号码。', + 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'- 在智能语音交互通话中，支持使用控制台预设的机器人话术，或在每轮通话中通过回调接口返回业务方设置的回应方式。'."\n" ."\n" - .'- 语音文件公共模式和专属模式不通用，如果您使用公共模式调用本接口，请在**导入语音文件时外呼号码选择公共模式外呼**，专属模式同理。'."\n" + .'- 此接口用于直接使用控制台预设的机器人话术，发起机器人外呼任务。'."\n" ."\n" - .'- 语音通知文件不支持变量参数，如您需要发送带变量的语音通知，请至[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/addt2v)申请**文本转语音模板**后使用[SingleCallByTts](~~393519~~)接口。'."\n" + .'### 前提条件'."\n" + .'- 已实名认证为企业用户，并审核通过了企业资质。'."\n" + .'- 已在[语音服务控制台](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal)上购买了号码。 '."\n" + .'- 已在[话术管理页面](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list)添加了话术并通过审核。'."\n" ."\n" - .'- 如果需要批量发送语音任务，请使用[CreateCallTask](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.12771c4esA3Fbv)接口创建语音任务（创建语音任务仅限专属模式且需使用服务实例调用）。'."\n" - ."\n\n" - .'### QPS限制'."\n" - .'单用户调用频率：1200次/秒。', + .'> 请确保在使用该接口前，已充分了解语音服务产品的收费方式和[价格](https://www.aliyun.com/price/product#/vms/detail)。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SingleCallByTts' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRobotSmartCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:BatchRobotSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CancelCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52711', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'CallId', 'in' => 'query', + 'schema' => ['description' => '此次通话的唯一回执ID。可以从[ClickToDial](https://help.aliyun.com/document_detail/114040.htm)接口的返回信息中获取。', 'type' => 'string', 'required' => true, 'example' => '116012854210^10281427****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '发送语音通知或语音验证码的通话号码（被叫显号）。若此参数不填，则为公共模式通话；若传入真实号或服务实例ID，则为专属模式通话。**参数`TtsCode`传入的模板ID的外呼模式必须与此处外呼模式匹配**。'."\n" - ."\n" - .'- 如果您使用公共模式，该参数不填，将由系统随机调度使用公共号码池内的号码通话。公共模式与专属模式区别请参见[公共模式/专属模式](~~172104~~)。'."\n" - .'- 如果您使用专属模式，请传入您的**真实号码**或**服务实例ID**。'."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**服务实例管理**页面查看已创建并绑定真实号的**服务实例**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '是否成功取消呼叫。取值：'."\n" + ."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelCallResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</CancelCallResponse>","errorExample":""}]', + 'title' => '取消语音双呼', + 'summary' => '调用CancelCall接口取消ClickToDial发起的语音双呼。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:CancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'CancelOrderRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CalledNumber', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。可以通过[CreateRobotTask](~~393531~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '接收语音通知或语音验证码的被叫号码。'."\n" - ."\n" - .'号码格式：'."\n" - .'- 手机号码。示例：159****0000。'."\n" - .'- 固话号码。示例：0571****5678。'."\n" - .'> - 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n" - .'> - 同一个**资质信息+号码用途**，拨打每一个被叫号码的频次有流控限制：1次/分钟、5次/小时、20次/24小时。 流控规则计时从第一次正常外呼开始，超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。'."\n" - .'> - 如**使用专属模式**调用此接口且您的业务需要更宽松的流控频率，您可至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)--通用设置--呼叫设置--呼出流控-频次中，尝试**申请调整流控次数**，**公共模式不支持**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****000', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', 'type' => 'string', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelOrderRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</CancelOrderRobotTaskResponse>","errorExample":""}]', + 'title' => '取消智能语音任务', + 'summary' => '取消还未启动的定时智能语音任务。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrderRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelOrderRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CancelRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TtsCode', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1045001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '文本转语音模板或语音验证码模板的模板ID。'."\n" - .'您可登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在以下页面获取已通过审核的语音模板ID。'."\n" - .'- 在**语音消息**>**语音验证码**获取**模板ID**。'."\n" - .'- 在**语音消息**>**语音通知**页面获取**模板ID**。'."\n" - ."\n\n" - .'><notice>'."\n" - ."\n" - .'- 在控制台选择模板ID时请注意**外呼号码**字段是否与参数`CalledShowNumber`的外呼模式匹配。'."\n" - .'- 语音模板归属账号和调用该接口的账号需保持一致。'."\n" - .'</notice>', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TTS_28726****', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', 'type' => 'string', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', + 'title' => '终止智能语音任务', + 'summary' => '终止智能语音任务。', + 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'- 仅可终止进行中的任务，任务终止后不能再恢复。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CloudAgentLogin' => [ + 'summary' => '使用此接口将座席上线。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TtsParam', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '语音模板中的变量参数，JSON格式。'."\n" - .'变量规范详情，请参见[模板规范](https://help.aliyun.com/zh/vms/user-guide/voice-template-specification?spm=a2c4g.11186623.0.0.6ebf68529bX2fG)。', - 'type' => 'string', - 'required' => false, - 'example' => '{"AckNum":"123456"}', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'PlayTimes', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '语音文件或语音验证的播放次数。取值范围：**1~3**，默认取值**3**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '座席工号；取值3-10位正整数', 'description' => '座席工号；取值3-10位正整数', 'type' => 'string', 'required' => true, 'example' => '1111'], ], [ - 'name' => 'Volume', + 'name' => 'BindTel', 'in' => 'query', - 'schema' => [ - 'description' => '语音通话的音量。取值范围：**0~100**，默认取值**100**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['title' => '绑定电话', 'description' => '绑定电话', 'type' => 'string', 'required' => true, 'example' => '41008502'], ], [ - 'name' => 'Speed', + 'name' => 'BindType', 'in' => 'query', - 'schema' => [ - 'description' => '语音通话的语速。取值范围为：**-500~500**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['title' => '取值 1.普通电话,2.分机,3.webrtc </br>说明：绑定类型如果是分机则必须先让分机电话设备注册成功。如果绑定类型为webrtc，就算调用接口成功也是无法呼叫的。如果在企业设置页面开启了自适应绑定电话类型，则系统会根据绑定的号码来找到对应的绑定类型，使用系统找到的绑定类型，此处的设置优先级低。', 'description' => '取值 1.普通电话,2.分机,3.webrtc </br>说明：绑定类型如果是分机则必须先让分机电话设备注册成功。如果绑定类型为webrtc，就算调用接口成功也是无法呼叫的。如果在企业设置页面开启了自适应绑定电话类型，则系统会根据绑定的号码来找到对应的绑定类型，使用系统找到的绑定类型，此处的设置优先级低。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'OutId', + 'name' => 'LoginStatus', 'in' => 'query', - 'schema' => [ - 'description' => '发起请求时预留给调用方的自定义ID，最终会通过回执消息将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度限制为1~15个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['title' => '登录状态，1：置闲，2：置忙，默认为1', 'description' => '登录状态，1：置闲，2：置忙，默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PauseDescription', + 'in' => 'query', + 'schema' => ['title' => '置忙描述', 'description' => '置忙描述', 'type' => 'string', 'required' => false, 'example' => 'description'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'CallId' => [ - 'description' => '此次通话的唯一回执ID。'."\n" - ."\n" - .'可以使用此CallId，调用[QueryCallDetailByCallId](~~393529~~)接口查询呼叫详情。', - 'type' => 'string', - 'example' => '116012354148^10281378****', + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => '发送语音验证码或文本转语音类型的语音通知', - 'summary' => '调用接口给单个被叫号码发送语音验证码或文本转语音类型的语音通知。', - 'description' => '- 请在使用该接口前，了解语音服务套餐包及功能计费，详情请参见[国内语音服务定价](~~150083~~)。'."\n" - ."\n" - .'- 文本转语音模板公共模式和专属模式不通用，如果您使用公共模式调用本接口，请申请并使用**公共模式**的语音模板发起通话，专属模式同理。'."\n" - ."\n" - .'- 如果需要批量发送语音任务，请使用[CreateCallTask](~~393512~~)接口创建语音任务（创建语音任务仅限专属模式且需使用服务实例调用）。'."\n" - ."\n" - .'- 本接口支持发送语音验证码或文本转语音类型的语音通知，如您需要发送语音通知文件类型的语音通知，请至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)上传语音文件后使用[SingleCallByVoice](~~393517~~)接口。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：1000次/秒。', - 'requestParamsDescription' => '请在调用前确认您传入的模板ID外呼模式类型是否与参数`CalledShowNumber`匹配，不匹配时无法调用成功：'."\n" - ."\n" - .'- 若`CalledShowNumber`不填：即为**公共模式**，参数`TtsCode`应**传入外呼号码为公共模式外呼**的模板ID。'."\n" - .'- 若`CalledShowNumber`填入自行申请的真实号或服务实例ID：即为**专属模式**，参数`TtsCode`应**传入外呼号码为专属模式外呼**的模板ID。', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席上线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudAgentLogout' => [ + 'summary' => '下线座席。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '通话的任务名称。', - 'type' => 'string', - 'required' => false, - 'example' => '语音通知', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'BizType', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '语音模板类型。取值：'."\n" - ."\n" - .'- **VMS\\_VOICE_TTS**：语音通知文本转语音模板。'."\n" - ."\n" - .'- **VMS\\_VOICE_CODE**：语音通知文件模板。'."\n" - ."\n" - .'- **VMS_TTS**：语音验证码模板。', - 'type' => 'string', - 'required' => false, - 'example' => 'VMS_VOICE_CODE', - ], + 'schema' => ['title' => '座席工号；取值3-10位正整数', 'description' => '座席工号；取值3-10位正整数', 'type' => 'string', 'required' => true, 'example' => '1111'], ], [ - 'name' => 'TemplateCode', + 'name' => 'RemoveBinding', 'in' => 'query', - 'schema' => [ - 'description' => '模板Code。取值：'."\n" - ."\n" - .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板ID**。'."\n" - ."\n" - .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音ID**。'."\n" - ."\n" - .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板ID**。', - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_2122****', - ], + 'schema' => ['title' => '取值： 0:不解除绑定电话， 1:解除绑定电话 默认为0', 'description' => '取值： 0:不解除绑定电话， 1:解除绑定电话 默认为0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'TemplateName', + 'name' => 'IsKickout', 'in' => 'query', - 'schema' => [ - 'description' => '模板名称。取值：'."\n" - .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板名称**。'."\n" - ."\n" - .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音文件名**。'."\n" - ."\n" - .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板名称**。', - 'type' => 'string', - 'required' => false, - 'example' => '语音通知模板', - ], + 'schema' => ['title' => '是否给座席发生kickout事件；取值： 0:不发送， 1:发送 默认为1，发送', 'description' => '是否给座席发生kickout事件；取值： 0:不发送， 1:发送 默认为1，发送', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ResourceType', + 'name' => 'IgnoreOffline', 'in' => 'query', + 'schema' => ['title' => '是否忽略重复下线报错；取值：0:不忽略 1:忽略 默认为0，不忽略', 'description' => '是否忽略重复下线报错；取值：0:不忽略 1:忽略 默认为0，不忽略', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '主叫号码类型。固定取值：**LIST**。', - 'type' => 'string', - 'required' => false, - 'example' => 'LIST', - 'default' => 'LIST', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席下线', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudAgentMonitorStatistics' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Resource', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码，请传入服务实例ID。**目前仅支持已绑定真实号的服务实例，服务实例下未绑定真实号码无法发起通话任务**。'."\n" - ."\n" - .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)**服务实例管理**页面获取服务实例ID或绑定真实号码。', - 'type' => 'string', - 'required' => false, - 'example' => '05516214****', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'DataType', + 'name' => 'Fields', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码类型。取值：'."\n" - ."\n" - .'- **LIST**：LIST格式用于无变量的文本转语音模板或语音文件。'."\n" - .'- **JSON**：JSON格式用于内含变量参数的文本转语音模板。', - 'type' => 'string', - 'required' => false, - 'example' => 'JSON', - ], + 'schema' => ['title' => '统计项名称；取队列实时统计的统计字段名称，多个队列统计项之间使用英文逗号","分隔，默认查询所有统计项', 'description' => '统计项名称；取队列实时统计的统计字段名称，多个队列统计项之间使用英文逗号","分隔，默认查询所有统计项', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ - 'name' => 'Data', + 'name' => 'Cnos', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码或包含变量参数值的被叫数据。'."\n" - ."\n" - .'- 当**DataType**取值为**LIST**时，传入用英文半角逗号`,`分隔的被叫号码。填写格式示例`187*****123,021****1234,177*****123`。'."\n" - .'- 当**DataType**取值为**JSON**时，被叫号码及变量传参填写格式请参考示例值。示例值中`paramNames`对应文本转语音模板内的变量名，`calleelist`为被叫数据（`callee`对应被叫号码，`params`对应模板变量实际传值）。'."\n" - ."\n" - .'> 被叫号码为固话号码如`021-12345678`，应传入`02112345678`。', - 'type' => 'string', - 'required' => false, - 'example' => '{ "paramNames":["name",,"key"], "calleeList":[ { "callee":"1310000****", "params":["张三","淘宝订单"] }, { "callee":"1320000****", "params":["李四","天猫订单"] } ] }', - ], + 'schema' => ['title' => '说明：根据座席工号查询指定座席的统计项名称支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的统计信息', 'description' => '说明：根据座席工号查询指定座席的统计项名称支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的统计信息', 'type' => 'string', 'required' => false, 'example' => '1111'], ], [ - 'name' => 'FireTime', + 'name' => 'IsUseGno', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不可用。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '是否需要外呼组查询；说明：0 关闭外呼组查询，1 开启外呼组查询。默认为关闭状态', 'description' => '是否需要外呼组查询；说明：0 关闭外呼组查询，1 开启外呼组查询。默认为关闭状态', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'StopTime', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不可用。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '说明：根据外呼组编号查询指定座席的统计项名称支持按照多个外呼组编号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的统计信息', 'description' => '说明：根据外呼组编号查询指定座席的统计项名称支持按照多个外呼组编号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的统计信息', 'type' => 'string', 'required' => false, 'example' => 'WH123'], ], [ - 'name' => 'ScheduleType', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不可用。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '条数；正整数，默认值是10，最大值是500', 'description' => '条数；正整数，默认值是10，最大值是500', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['title' => '查询页码数的起始条数；正整数，默认值是0；与limit同步使用，例：offset=50,limit=10,表示查询第6页，每页10条数据，即总记录的第51-60条数据', 'description' => '查询页码数的起始条数；正整数，默认值是0；与limit同步使用，例：offset=50,limit=10,表示查询第6页，每页10条数据，即总记录的第51-60条数据', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['title' => '统计时间段；正整数，0～23，最大值是23时', 'description' => '统计时间段；正整数，0～23，最大值是23时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['title' => '统计时间段；正整数，1～24，最大值是24时', 'description' => '统计时间段；正整数，1～24，最大值是24时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23'], + ], + [ + 'name' => 'IsNeedQueueName', + 'in' => 'query', + 'schema' => ['title' => '是否需要返回队列名称；0：不需要（默认） 1：需要', 'description' => '是否需要返回队列名称；0：不需要（默认） 1：需要', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '任务ID。使用此任务ID，通过[ExecuteCallTask](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-executecalltask?spm=a2c4g.11186623.0.0.2fb55105AJKYdF)接口执行通话任务。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18390**', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'ED815433-724A-4357-9991-A54AD2FF09FD', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AgentStatistics' => [ + 'title' => '座席统计项数组', + 'description' => '座席统计项数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Idle_count' => ['title' => '总空闲次数', 'description' => '总空闲次数', 'type' => 'string', 'example' => '5'], + 'GroupName' => ['title' => '外呼组名称', 'description' => '外呼组名称', 'type' => 'string', 'example' => 'gpname'], + 'Max_idle_time' => ['title' => '最大空闲时长', 'description' => '最大空闲时长', 'type' => 'string', 'example' => '52375'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'Ob_bridge_count' => ['title' => '总外呼通话次数', 'description' => '总外呼通话次数', 'type' => 'string', 'example' => '4'], + 'Min_ob_calling_time' => ['title' => '外呼呼叫最小时长', 'description' => '外呼呼叫最小时长', 'type' => 'string', 'example' => '8'], + 'Gno' => ['title' => '外呼组编号', 'description' => '外呼组编号', 'type' => 'string', 'example' => 'WH123'], + 'Preview_ob_max_bridge_time' => ['title' => '双方接听最大通话时长', 'description' => '双方接听最大通话时长', 'type' => 'string', 'example' => '41'], + 'Min_ob_wrapup_time' => ['title' => '外呼整理最小时长', 'description' => '外呼整理最小时长', 'type' => 'string', 'example' => '30'], + 'Max_ob_bridge_time' => ['title' => '外呼通话最大时长', 'description' => '外呼通话最大时长', 'type' => 'string', 'example' => '41'], + 'Ob_bridge_time' => ['title' => '外呼通话时长', 'description' => '外呼通话时长', 'type' => 'string', 'example' => '144'], + 'Preview_ob_total_count' => ['title' => '预览外呼数', 'description' => '预览外呼数', 'type' => 'string', 'example' => '5'], + 'Max_ob_wrapup_time' => ['title' => '外呼整理最大时长', 'description' => '外呼整理最大时长', 'type' => 'string', 'example' => '30'], + 'Ob_wrapup_count' => ['title' => '总外呼整理次数', 'description' => '总外呼整理次数', 'type' => 'string', 'example' => '4'], + 'CurrentState' => ['title' => 'status: 代表座席状态，状态每个值对应的含义: stateIdle: 置闲; statePause: 置忙; stateCalling: 呼叫中; stateInuse: 通话中; stateWrapup: 整理, loginTime: 代表座席登录时间, startTime: 代表开始通话的时间', 'description' => 'status: 代表座席状态，状态每个值对应的含义: stateIdle: 置闲; statePause: 置忙; stateCalling: 呼叫中; stateInuse: 通话中; stateWrapup: 整理, loginTime: 代表座席登录时间, startTime: 代表开始通话的时间', 'type' => 'string', 'example' => '{\\"state\\":\\"stateIdle\\",\\"startTime\\":\\"1491462675\\"}'], + 'Ob_calling_time' => ['title' => '外呼呼叫时长', 'description' => '外呼呼叫时长', 'type' => 'string', 'example' => '67'], + 'Idle_time' => ['title' => '总空闲时长', 'description' => '总空闲时长', 'type' => 'string', 'example' => '54344'], + 'QueueName' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => '0005,0006,test测试'], + 'Preview_ob_valid_calls' => ['title' => '预览外呼有效通话次数', 'description' => '预览外呼有效通话次数', 'type' => 'string', 'example' => '4'], + 'Min_ob_bridge_time' => ['title' => '外呼通话最小时长', 'description' => '外呼通话最小时长', 'type' => 'string', 'example' => '29'], + 'Ob_wrapup_time' => ['title' => '外呼整理时长', 'description' => '外呼整理时长', 'type' => 'string', 'example' => '120'], + 'Preview_ob_agent_answered_count' => ['title' => '预览外呼座席接听数', 'description' => '预览外呼座席接听数', 'type' => 'string', 'example' => '4'], + 'Preview_ob_min_bridge_time' => ['title' => '双方接听最小通话时长', 'description' => '双方接听最小通话时长', 'type' => 'string', 'example' => '29'], + 'Preview_ob_both_answered_count' => ['description' => '预览外呼双方接听数', 'type' => 'string', 'example' => '4'], + 'Ob_calling_count' => ['title' => '总外呼呼叫次数', 'description' => '总外呼呼叫次数', 'type' => 'string', 'example' => '5'], + 'Min_idle_time' => ['title' => '最小空闲时长', 'description' => '最小空闲时长', 'type' => 'string', 'example' => '9'], + 'Preview_ob_total_bridge_time' => ['title' => '双方接听总通话时长', 'description' => '双方接听总通话时长', 'type' => 'string', 'example' => '144'], + 'Max_ob_calling_time' => ['title' => '外呼呼叫最大时长', 'description' => '外呼呼叫最大时长', 'type' => 'string', 'example' => '31'], + 'Preview_ob_valid_total_bridge_time' => ['title' => '预览外呼有效通话总时长', 'description' => '预览外呼有效通话总时长', 'type' => 'string', 'example' => '144'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'Total' => ['title' => '总计', 'description' => '总数据条数', 'type' => 'string', 'example' => '26'], + 'Date' => ['title' => '日期，格式为：yyyy-MM-dd', 'description' => '日期，格式为：yyyy-MM-dd', 'type' => 'string', 'example' => '2026-04-06'], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席实时统计', + 'summary' => '实时统计座席通话数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"ED815433-724A-4357-9991-A54AD2FF09FD\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCallTaskResponse>\\n <Code>200</Code>\\n <Data>123456</Data>\\n <RequestId>ED815433-724A-4357-9991-A54AD2FF09FD</RequestId>\\n</CreateCallTaskResponse>","errorExample":""}]', - 'title' => '创建语音通话任务', - 'summary' => '使用服务实例给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。', - 'description' => '- **此接口仅支持专属模式且通话号码需要使用已绑定真实号的服务实例**，**服务实例下未绑定真实号码时无法发起外呼**。相关操作请参见[真实号申请](~~211339~~)及[创建服务实例](~~2261148~~)。'."\n" - ."\n" - .'- 如需使用公共模式实现批量通话，可多次调用[SingleCallByVoice](~~393517~~)或[SingleCallByTts](~~393519~~)接口，每一次调用仅支持给单个被叫号码发送语音通知或语音验证码。'."\n" - ."\n" - .'- 通话任务创建完成后，请使用[ExecuteCallTask](~~393515~~)接口执行通话任务。您也可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面执行通话任务。'."\n" - ."\n" - .'- 使用此接口创建一次通话任务，最多支持创建1000条语音通知任务。'."\n" - ."\n" - .'- 为保证用户良好的通话体验，每天12:00至14:00，21:00至次日09:00时间段内无法执行语音通话任务。如您的业务场景需要保证全天候时间段内可发起通话，可使用无时段限制的[SingleCallByVoice](~~393517~~)或[SingleCallByTts](~~393519~~)接口。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AgentStatistics\\": [\\n {\\n \\"Idle_count\\": \\"5\\",\\n \\"GroupName\\": \\"gpname\\",\\n \\"Max_idle_time\\": \\"52375\\",\\n \\"Cno\\": \\"1111\\",\\n \\"Ob_bridge_count\\": \\"4\\",\\n \\"Min_ob_calling_time\\": \\"8\\",\\n \\"Gno\\": \\"WH123\\",\\n \\"Preview_ob_max_bridge_time\\": \\"41\\",\\n \\"Min_ob_wrapup_time\\": \\"30\\",\\n \\"Max_ob_bridge_time\\": \\"41\\",\\n \\"Ob_bridge_time\\": \\"144\\",\\n \\"Preview_ob_total_count\\": \\"5\\",\\n \\"Max_ob_wrapup_time\\": \\"30\\",\\n \\"Ob_wrapup_count\\": \\"4\\",\\n \\"CurrentState\\": \\"{\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"stateIdle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1491462675\\\\\\\\\\\\\\"}\\",\\n \\"Ob_calling_time\\": \\"67\\",\\n \\"Idle_time\\": \\"54344\\",\\n \\"QueueName\\": \\"0005,0006,test测试\\",\\n \\"Preview_ob_valid_calls\\": \\"4\\",\\n \\"Min_ob_bridge_time\\": \\"29\\",\\n \\"Ob_wrapup_time\\": \\"120\\",\\n \\"Preview_ob_agent_answered_count\\": \\"4\\",\\n \\"Preview_ob_min_bridge_time\\": \\"29\\",\\n \\"Preview_ob_both_answered_count\\": \\"4\\",\\n \\"Ob_calling_count\\": \\"5\\",\\n \\"Min_idle_time\\": \\"9\\",\\n \\"Preview_ob_total_bridge_time\\": \\"144\\",\\n \\"Max_ob_calling_time\\": \\"31\\",\\n \\"Preview_ob_valid_total_bridge_time\\": \\"144\\"\\n }\\n ],\\n \\"Total\\": \\"26\\",\\n \\"Date\\": \\"2026-04-06\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAgentSetUserData' => [ + 'summary' => '使用此接口设置座席随路数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'PageSize', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '每页显示的任务个数。默认取值为**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['title' => '座席工号；取值3-10位正整数', 'description' => '座席工号；取值3-10位正整数', 'type' => 'string', 'required' => true, 'example' => '1111'], ], [ - 'name' => 'TemplateName', + 'name' => 'Direction', 'in' => 'query', - 'schema' => [ - 'description' => '模板名称。'."\n" - .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板名称**。'."\n" - ."\n" - .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音文件名**。'."\n" - ."\n" - .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板名称**。', - 'type' => 'string', - 'required' => false, - 'example' => '身份验证', - ], + 'schema' => ['title' => '随路数据方向；取值说明：1： 座席侧，2： 非座席侧', 'description' => '随路数据方向；取值说明：1： 座席侧，2： 非座席侧', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Status', + 'name' => 'UserData', 'in' => 'query', + 'schema' => ['title' => 'json格式字符串,传入的值会打入通道变量,格式：json字符串{"key":"value"} 随路数据数据格式：key=value,不支持数组，嵌套。', 'description' => 'json格式字符串,传入的值会打入通道变量,格式：json字符串{"key":"value"} 随路数据格式：key=value,不支持数组，嵌套。', 'type' => 'string', 'required' => true, 'example' => '{"key":"value"}'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务状态。取值：'."\n" - ."\n" - .'- **INIT**：新建任务，任务未启动。'."\n" - .'- **RELEASE**：任务解析中。'."\n" - .'- **RUNNING**：任务运行中。'."\n" - .'- **STOP**：任务暂停。'."\n" - .'- **SYSTEM_STOP**：系统暂停。'."\n" - .'- **CANCEL**：任务取消。'."\n" - .'- **SYSTEM_CANCEL**：系统取消。'."\n" - .'- **DONE**：任务已完成。'."\n" - ."\n" - .'> 您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'INIT', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席设置随路数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudAgentUnlink' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TaskName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '任务名称。'."\n" - ."\n" - .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务名称。', - 'type' => 'string', - 'required' => false, - 'example' => '验证码', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'TaskId', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。'."\n" - ."\n" - .'- 通过[CreateCallTask接口](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.51c25dac5r5vgj)获取任务ID。'."\n" - ."\n" - .'- 在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务ID。', - 'type' => 'string', - 'required' => false, - 'example' => '18908**', - ], + 'schema' => ['title' => '座席工号；取值3-10位正整数，参数cno,uniqueId和requestUniqueId三选一', 'description' => '座席工号；取值3-10位正整数，参数cno,uniqueId和requestUniqueId三选一', 'type' => 'string', 'required' => false, 'example' => '1111'], ], [ - 'name' => 'BizType', + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '通话唯一标识；参数cno,uniqueId和requestUniqueId三选一', 'description' => '通话唯一标识；参数cno,uniqueId和requestUniqueId三选一', 'type' => 'string', 'required' => false, 'example' => '1233456789'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '请求唯一标识；参数cno,uniqueId和requestUniqueId三选一。注意：requestUniqueId挂机功能只在呼叫类型为webcall时生效，且需提前在管理后台将功能开启', 'description' => '请求唯一标识；参数cno,uniqueId和requestUniqueId三选一。注意：requestUniqueId挂机功能只在呼叫类型为webcall时生效，且需提前在管理后台将功能开启', 'type' => 'string', 'required' => false, 'example' => '1233456789'], + ], + [ + 'name' => 'Side', 'in' => 'query', + 'schema' => ['title' => '是否座席侧挂机；取值范围：1,2（数字含义，座席侧，非座席侧)，默认座席侧', 'description' => '是否座席侧挂机；取值范围：1,2（数字含义，座席侧，非座席侧)，默认座席侧', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务模板类型。取值：'."\n" - ."\n" - .'- **VMS_VOICE_TTS**：语音通知文本转语音模板。'."\n" - .'- **VMS_VOICE_CODE**：语音通知文件模板。'."\n" - .'- **VMS_TTS**：语音验证码模板。', - 'type' => 'string', - 'required' => false, - 'example' => 'VMS_TTS', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席挂机', + 'summary' => '座席挂机。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudAgentWorkloadReport' => [ + 'summary' => '获取座席工作量报表数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'StatisticMethod', + 'in' => 'query', + 'schema' => ['title' => '统计方法；说明：0：分时1：分日2：汇总 10：队列汇总', 'description' => '统计方法；说明：'."\n" + .'- 0：分时'."\n" + .'- 1：分日'."\n" + .'- 2：汇总'."\n" + .'- 10：队列汇总', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '说明：统计报表类型，1：日报表2：周报表3：月报表4：自定义时间', 'description' => '说明：统计报表类型，1：日报表2：周报表3：月报表4：自定义时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-13'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2025-06-15'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席号；说明：根据座席工号查询指定座席的工作量统计支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的工作量统计', 'description' => '座席号；说明：根据座席工号查询指定座席的工作量统计支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的工作量统计', 'type' => 'string', 'required' => false, 'example' => '1111,2222'], + ], + [ + 'name' => 'Gnos', + 'in' => 'query', + 'schema' => ['title' => '说明：根据外呼编号查询指定座席的工作量统计,默认查询账户下所有座席的工作量统计', 'description' => '说明：根据外呼编号查询指定座席的工作量统计,默认查询账户下所有座席的工作量统计', 'type' => 'string', 'required' => false, 'example' => 'WH12'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '查询起始位置；取值：大于等于0，默认0', 'description' => '查询起始位置；取值：大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '查询条数；取值：最大不能超过1000，默认10', 'description' => '查询条数；取值：最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回200代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => '200', - ], - 'PageSize' => [ - 'description' => '每页显示的任务个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991', - ], - 'Total' => [ - 'description' => '任务总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '756BCB70-492E-5877-ABEB-03BB5CA28540'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '任务信息。', - 'type' => 'array', - 'items' => [ - 'description' => '任务信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '任务状态。取值：'."\n" - ."\n" - .'- **INIT**：新建任务，任务未启动。'."\n" - .'- **RELEASE**：任务解析中。'."\n" - .'- **RUNNING**：任务运行中。'."\n" - .'- **STOP**：任务暂停。'."\n" - .'- **SYSTEM_STOP**：系统暂停。'."\n" - .'- **CANCEL**：任务取消。'."\n" - .'- **SYSTEM_CANCEL**：系统取消。'."\n" - .'- **DONE**：任务已完成。'."\n" - ."\n" - .'> 您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态。', - 'type' => 'string', - 'example' => 'INIT'."\n", - ], - 'Data' => [ - 'description' => '返回的任务状态数据。', - 'type' => 'string', - 'example' => '1', - ], - 'DataType' => [ - 'description' => '被叫号码类型。'."\n" - ."\n" - .'在[创建通话任务](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.c24e3a52pFfNZV)时已选择被叫号码类型。', - 'type' => 'string', - 'example' => 'LIST', - ], - 'TaskName' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'example' => '验证码', - ], - 'CompletedCount' => [ - 'description' => '已完成任务的个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TotalCount' => [ - 'description' => '被叫号码总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'TemplateName' => [ - 'description' => '模板名称。', - 'type' => 'string', - 'example' => '身份验证', - ], - 'StopTime' => [ - 'description' => '任务暂停时间。', - 'type' => 'string', - 'example' => '1614332378000', - ], - 'BizType' => [ - 'description' => '任务模板类型。取值：'."\n" - ."\n" - .'- **VMS_VOICE_TTS**：语音通知文本转语音模版。'."\n" - .'- **VMS_VOICE_CODE**：语音通知文件模版。'."\n" - .'- **VMS_TTS**：语音验证码模版。', - 'type' => 'string', - 'example' => 'VMS_TTS', - ], - 'Resource' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0571000****', - ], - 'TemplateCode' => [ - 'description' => '语音模板ID。', - 'type' => 'string', - 'example' => 'TTS_28292****', - ], - 'FireTime' => [ - 'description' => '定时启动任务。Unix时间戳格式，单位：毫秒。', - 'type' => 'string', - 'example' => '1614330978000', - ], - 'CompleteTime' => [ - 'description' => '任务完成时间。Unix时间戳格式，单位：毫秒。', - 'type' => 'string', - 'example' => '1614330986000', - ], - 'CompletedRate' => [ - 'description' => '任务执行进度。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '26%', - ], - 'Id' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605***', + 'description' => '返回的数据。', + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => ['description' => '总页数', 'type' => 'string', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '页容量', 'type' => 'string', 'example' => '10'], + 'List' => [ + 'description' => '报表数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IbMonitorPickupDuration' => ['title' => '呼入抢线时长', 'description' => '呼入抢线时长', 'type' => 'string', 'example' => '0'], + 'DirectObAnsweredDurationArray' => ['title' => '主叫外呼接听量分布', 'description' => '主叫外呼接听量分布', 'type' => 'string', 'example' => '0'], + 'AvgIdleTime' => ['title' => '平均空闲时长', 'description' => '平均空闲时长', 'type' => 'string', 'example' => '00:00:01'], + 'PredictObValidTotalBridgeTime' => ['title' => '预测外呼有效通话时长', 'description' => '预测外呼有效通话时长', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'ObMinWrapupTime' => ['title' => '外呼最小整理时长', 'description' => '外呼最小整理时长', 'type' => 'string', 'example' => '00:00:00'], + 'DirectObMonitorThreewayCount' => ['title' => '主叫外呼监控三方总次数', 'description' => '主叫外呼监控三方总次数', 'type' => 'string', 'example' => '0'], + 'PredictObConsultCount' => ['title' => '预测外呼咨询数', 'description' => '预测外呼咨询数', 'type' => 'string', 'example' => '0'], + 'PreviewObCustomerRingingRate' => ['title' => '响铃率', 'description' => '响铃率', 'type' => 'string', 'example' => '100%'], + 'PreviewObValidTotalBridgeHour' => ['title' => '预览外呼有效通话总小时', 'description' => '预览外呼有效通话总小时', 'type' => 'string', 'example' => '1'], + 'ObBridgeCount' => ['title' => '外呼通话次数', 'description' => '外呼通话次数', 'type' => 'string', 'example' => '3'], + 'IbMonitorSpyCount' => ['title' => '呼入监控监听数', 'description' => '呼入监控监听数', 'type' => 'string', 'example' => '3'], + 'PredictObMonitorBargeDuration' => ['title' => '预测外呼强插时长', 'description' => '预测外呼强插时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbAnsweredDurationArray' => [ + 'title' => '接听量分布', + 'description' => '接听量分布', + 'type' => 'array', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '""'], + 'example' => '""', + ], + 'PreviewObMonitorWhisperDuration' => ['title' => '预览外呼耳语时长', 'description' => '预览外呼耳语时长', 'type' => 'string', 'example' => '00:00:00'], + 'AgentAnswerRate' => ['title' => '座席来电接听率', 'description' => '座席来电接听率', 'type' => 'string', 'example' => '80%'], + 'AgentName' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => 'test-3'], + 'MinRestTime' => ['title' => '最小休息时长', 'description' => '最小休息时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObTransferCount' => ['title' => 'webcall转移数', 'description' => 'webcall转移数', 'type' => 'string', 'example' => '0'], + 'IbMinBridgeTime' => ['title' => '呼入最小通话时长', 'description' => '呼入最小通话时长', 'type' => 'string', 'example' => '00:00:10'."\n"], + 'IbUniqueAnsweredCount' => ['title' => '座席来电接听数', 'description' => '座席来电接听数', 'type' => 'string', 'example' => '3'], + 'PauseTime' => ['title' => '总置忙时长', 'description' => '总置忙时长', 'type' => 'string', 'example' => '00:00:10'], + 'DirectObAnsweredCount' => ['title' => '主叫外呼客户接听数', 'description' => '主叫外呼客户接听数', 'type' => 'string', 'example' => '4'], + 'PredictObAgentAnsweredTime' => ['title' => '预测外呼座席接听通话总时长', 'description' => '预测外呼座席接听通话总时长', 'type' => 'integer', 'format' => 'int64', 'example' => '72'], + 'PreviewObMonitorDisconnectCount' => ['title' => '预览外呼监控强拆数', 'description' => '预览外呼监控强拆数', 'type' => 'string', 'example' => '0'], + 'ObAvgWrapupTime' => ['title' => '外呼平均整理时长', 'description' => '外呼平均整理时长', 'type' => 'string', 'example' => '00:00:05'], + 'ObAvgHoldTime' => ['title' => '外呼平均保持时长', 'description' => '外呼平均保持时长', 'type' => 'string', 'example' => '00:00:50'], + 'IbTotalCount' => ['title' => '总呼入座席数', 'description' => '总呼入座席数', 'type' => 'string', 'example' => '6'], + 'IbUnansweredCount' => ['title' => '呼入座席未接听数', 'description' => '呼入座席未接听数', 'type' => 'string', 'example' => '2'], + 'DirectObMonitorWhisperCount' => ['title' => '主叫外呼耳语总次数', 'description' => '主叫外呼耳语总次数', 'type' => 'string', 'example' => '0'], + 'PreviewObMonitorSpyDuration' => ['title' => '预览外呼监听时长', 'description' => '预览外呼监听时长', 'type' => 'string', 'example' => '0'], + 'IbMonitorPickupCount' => ['title' => '呼入监控抢线数', 'description' => '呼入监控抢线数', 'type' => 'string', 'example' => '0'], + 'IbCustomerHangupCount' => ['title' => '客户挂机数', 'description' => '客户挂机数', 'type' => 'string', 'example' => '3'], + 'PreviewObAnsweredDurationDscArray' => [ + 'title' => '预览外呼接听量分布描述', + 'description' => '预览外呼接听量分布描述', + 'type' => 'array', + 'items' => ['description' => '描述项', 'type' => 'string', 'example' => '10-30秒内'], + 'example' => '['."\n" + .' "10秒内",'."\n" + .' "10-30秒内",'."\n" + .' "30-60秒内",'."\n" + .' "1-2分钟内",'."\n" + .' "2-5分钟内",'."\n" + .' "5-10分钟内",'."\n" + .' "10-20分钟内",'."\n" + .' "20-30分钟内",'."\n" + .' "30-60分钟内",'."\n" + .' "1-2小时内",'."\n" + .' "2小时以上"'."\n" + .' ]', + ], + 'IbAgentHangupCount' => ['title' => '座席挂机数', 'description' => '座席挂机数', 'type' => 'string', 'example' => '0'], + 'PredictObMonitorSpyCount' => ['title' => '预测外呼监控监听数', 'description' => '预测外呼监控监听数', 'type' => 'string', 'example' => '0'], + 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => '123124'], + 'PredictObAgentAnsweredHour' => ['title' => '预测外呼座席接听通话总小时', 'description' => '预测外呼座席接听通话总小时', 'type' => 'string', 'example' => '1'], + 'ObWrapupCount' => ['title' => '外呼整理次数', 'description' => '外呼整理次数', 'type' => 'string', 'example' => '3'], + 'IbMaxAnswerDelayTime' => ['title' => '呼入接听最大延迟时间', 'description' => '呼入接听最大延迟时间', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObTotalBridgeTime' => ['title' => '预览外呼双方接听通话时长', 'description' => '预览外呼双方接听通话时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObMonitorSpyDuration' => ['title' => 'webcall监听时长', 'description' => 'webcall监听时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObAgentAnsweredCount' => ['title' => '预览外呼座席接听数', 'description' => '预览外呼座席接听数', 'type' => 'string', 'example' => '0'], + 'IbAgentRefuseCount' => ['title' => '来电座席拒接数', 'description' => '来电座席拒接数', 'type' => 'string', 'example' => '0'], + 'LoginTime' => ['title' => '总登录时长', 'description' => '总登录时长', 'type' => 'string', 'example' => '00:00:01'], + 'DirectObConsultCount' => ['title' => '主叫外呼咨询总次数', 'description' => '主叫外呼咨询总次数', 'type' => 'string', 'example' => '0'], + 'IbWrapupTime' => ['title' => '呼入总整理时长', 'description' => '呼入总整理时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObConsultCount' => ['title' => '预览外呼咨询数', 'description' => '预览外呼咨询数', 'type' => 'string', 'example' => '0'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'IbMaxWrapupTime' => ['title' => '呼入最大整理时长', 'description' => '呼入最大整理时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObMonitorDisconnectCount' => ['title' => 'webcall监控强拆数', 'description' => 'webcall监控强拆数', 'type' => 'string', 'example' => '0'], + 'IbMonitorThreewayCount' => ['title' => '呼入监控三方数', 'description' => '呼入监控三方数', 'type' => 'string', 'example' => '0'], + 'MaxRestTime' => ['title' => '最大休息时长', 'description' => '最大休息时长', 'type' => 'string', 'example' => '00:00:00'], + 'PredictObTransferCount' => ['title' => '预测外呼转移数', 'description' => '预测外呼转移数', 'type' => 'string', 'example' => '0'], + 'DirectObMonitorSpyCount' => ['title' => '主叫外呼监听总次数', 'description' => '主叫外呼监听总次数', 'type' => 'string', 'example' => '0'], + 'ObCallingTime' => ['title' => '外呼总呼叫时长', 'description' => '外呼总呼叫时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObTransferBridgeDuration' => ['title' => '预览外呼被转接听时长', 'description' => '预览外呼被转接听时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbTotalAnswerDelayTime' => ['title' => '呼入接听总延迟时间', 'description' => '呼入接听总延迟时间', 'type' => 'string', 'example' => '00:00:00'], + 'IbMinAnswerDelayTime' => ['title' => '呼入接听最小延迟时间', 'description' => '呼入接听最小延迟时间', 'type' => 'string', 'example' => '00:00:00'], + 'PredictObMonitorBargeCount' => ['title' => '预测外呼监控强插数', 'description' => '预测外呼监控强插数', 'type' => 'string', 'example' => '0'], + 'DirectObBridgeDuration' => ['title' => '主叫外呼总时长', 'description' => '主叫外呼总时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbAvgCallingTime' => ['title' => '呼入平均呼叫时长', 'description' => '呼入平均呼叫时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMaxBridgeTime' => ['title' => '呼入最大通话时长', 'description' => '呼入最大通话时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObTotalCount' => ['title' => '总预览外呼数', 'description' => '总预览外呼数', 'type' => 'string', 'example' => '0'], + 'PreviewObMonitorThreewayCount' => ['title' => '预览外呼监控三方数', 'description' => '预览外呼监控三方数', 'type' => 'string', 'example' => '0'], + 'DirectObTransferCount' => ['title' => '主叫外呼转移总次数', 'description' => '主叫外呼转移总次数', 'type' => 'string', 'example' => '0'], + 'PredictObTotalCount' => ['title' => '预测外呼总数', 'description' => '预测外呼总数', 'type' => 'integer', 'format' => 'int64', 'example' => '39'], + 'IbCallingTime' => ['title' => '呼入总呼叫时长', 'description' => '呼入总呼叫时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMonitorBargeCount' => ['title' => '呼入监控强插数', 'description' => '呼入监控强插数', 'type' => 'string', 'example' => '0'], + 'WebcallObAgentAnsweredTime' => ['title' => 'webcall座席接听分钟数', 'description' => 'webcall座席接听分钟数', 'type' => 'string', 'example' => '00:00:00'], + 'RestTime' => ['title' => '总休息时长', 'description' => '总休息时长', 'type' => 'string', 'example' => '00:00:00'], + 'PredictObValidTotalBridgeHour' => ['title' => '预测外呼有效通话总小时', 'description' => '预测外呼有效通话总小时', 'type' => 'string', 'example' => '0'], + 'IbConsultCount' => ['title' => '呼入咨询数', 'description' => '呼入咨询数', 'type' => 'string', 'example' => '0'], + 'IbBridgeMinute' => ['title' => '呼入通话分钟数', 'description' => '呼入通话分钟数', 'type' => 'string', 'example' => '00:00:00'], + 'PredictObMonitorDisconnectCount' => ['title' => '预测外呼监控强拆数', 'description' => '预测外呼监控强拆数', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'PreviewObAnsweredDurationArray' => [ + 'title' => '预览外呼接听量分布', + 'description' => '预览外呼接听量分布', + 'type' => 'array', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '""'], + 'example' => '', + ], + 'AgentRate' => ['title' => '座席呼叫接听率', 'description' => '座席呼叫接听率', 'type' => 'string', 'example' => '0%'], + 'WebcallObTotalCount' => ['title' => '总webcall数', 'description' => '总webcall数', 'type' => 'string', 'example' => '0'], + 'IbTotalMinute' => ['title' => '呼入总分钟数', 'description' => '呼入总分钟数', 'type' => 'string', 'example' => '0'], + 'MinIdleTime' => ['title' => '最小空闲时长', 'description' => '最小空闲时长', 'type' => 'string', 'example' => '00:00:01'], + 'PreviewObMonitorBargeCount' => ['title' => '预览外呼监控强插数', 'description' => '预览外呼监控强插数', 'type' => 'string', 'example' => '0'], + 'AgentStopTime' => ['title' => '座席停用时间', 'description' => '座席停用时间', 'type' => 'string', 'example' => '00:00:01'], + 'IbBridgeTime' => ['title' => '呼入双方接听时长', 'description' => '呼入双方接听时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMinHoldTime' => ['title' => '呼入最小保持时长', 'description' => '呼入最小保持时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMonitorSpyDuration' => ['title' => '呼入监听时长', 'description' => '呼入监听时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMonitorDisconnectCount' => ['title' => '呼入监控强拆数', 'description' => '呼入监控强拆数', 'type' => 'string', 'example' => '0'], + 'DirectObBridgeTime' => ['title' => '主叫外呼双方接听分钟数', 'description' => '主叫外呼双方接听分钟数', 'type' => 'string', 'example' => '00:00:00'], + 'ObMinHoldTime' => ['title' => '外呼最小保持时长', 'description' => '外呼最小保持时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObConsultCount' => ['title' => 'webcall咨询数', 'description' => 'webcall咨询数', 'type' => 'string', 'example' => '0'], + 'IbMinCallingTime' => ['title' => '呼入最小呼叫时长', 'description' => '呼入最小呼叫时长', 'type' => 'string', 'example' => '00:00:00'], + 'Day' => ['title' => '统计日期', 'description' => '统计日期', 'type' => 'string', 'example' => '2026-04-20'], + 'MinPauseTime' => ['title' => '最小置忙时长', 'description' => '最小置忙时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMinWrapupTime' => ['title' => '呼入最小整理时长', 'description' => '呼入最小整理时长', 'type' => 'string', 'example' => '00:00:00'], + 'RestCount' => ['title' => '休息次数', 'description' => '休息次数', 'type' => 'string', 'example' => '0'], + 'IbAvgBridgeTime' => ['title' => '呼入平均通话时长', 'description' => '呼入平均通话时长', 'type' => 'string', 'example' => '00:00:00'], + 'ObMaxHoldTime' => ['title' => '外呼最大保持时长', 'description' => '外呼最大保持时长', 'type' => 'string', 'example' => '00:00:01'], + 'IbHoldCount' => ['title' => '呼叫保持次数', 'description' => '呼叫保持次数', 'type' => 'string', 'example' => '0'], + 'WebcallObMonitorWhisperDuration' => ['title' => 'webcall耳语时长', 'description' => 'webcall耳语时长', 'type' => 'string', 'example' => '00:00:00'], + 'AvgPreviewObWaitTime' => ['title' => '平均等待时长', 'description' => '平均等待时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewCustomerAnswerdRate' => ['title' => '预览外呼客户接听率', 'description' => '预览外呼客户接听率', 'type' => 'string', 'example' => '0%'], + 'EnterpriseId' => ['title' => '企业id', 'description' => '企业id', 'type' => 'string', 'example' => '7000002'], + 'PredictObAnsweredCount' => ['title' => '预测外呼座席接听数', 'description' => '预测外呼座席接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '27'], + 'IbMonitorWhisperCount' => ['title' => '呼入监控耳语数', 'description' => '呼入监控耳语数', 'type' => 'string', 'example' => '0'], + 'PreviewObMonitorWhisperCount' => ['title' => '预览外呼监控耳语数', 'description' => '预览外呼监控耳语数', 'type' => 'string', 'example' => '0'], + 'IvrTransferCount' => ['title' => '预览外呼IVR转移座席数', 'description' => '预览外呼IVR转移座席数', 'type' => 'string', 'example' => '0'], + 'DirectObMonitorDisconnectCount' => ['title' => '主叫外呼总监控强拆次数', 'description' => '主叫外呼总监控强拆次数', 'type' => 'string', 'example' => '0'], + 'MaxPauseTime' => ['title' => '最大置忙时长', 'description' => '最大置忙时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMaxHoldTime' => ['title' => '呼入最大保持时长', 'description' => '呼入最大保持时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbAvgWrapupTime' => ['title' => '呼入平均整理时长', 'description' => '呼入平均整理时长', 'type' => 'string', 'example' => '00:00:10'], + 'PredictObMonitorThreewayCount' => ['title' => '预测外呼监控三方数', 'description' => '预测外呼监控三方数', 'type' => 'string', 'example' => '1'], + 'PreviewObTransferCount' => ['title' => '预览外呼被转数', 'description' => '预览外呼被转数', 'type' => 'string', 'example' => '1'], + 'ObMinCallingTime' => ['title' => '外呼最小呼叫时长', 'description' => '外呼最小呼叫时长', 'type' => 'string', 'example' => '0'], + 'AvgRestTime' => ['title' => '平均休息时长', 'description' => '平均休息时长', 'type' => 'string', 'example' => '00:00:03'], + 'IdleCount' => ['title' => '空闲次数', 'description' => '空闲次数', 'type' => 'string', 'example' => '0'], + 'AvgPauseTime' => ['title' => '平均置忙时长', 'description' => '平均置忙时长', 'type' => 'string', 'example' => '00:00:00'], + 'ObMaxCallingTime' => ['title' => '外呼最大呼叫时长', 'description' => '外呼最大呼叫时长', 'type' => 'string', 'example' => '00:00:03'], + 'IbTotalTime' => ['title' => '呼入总通话时长', 'description' => '呼入总通话时长', 'type' => 'string', 'example' => '3'], + 'AgentCreateTime' => ['title' => '座席创建时间', 'description' => '座席创建时间', 'type' => 'string', 'example' => '2019-04-20'], + 'PreviewObTotalBridgeHour' => ['title' => '预览外呼双方接听通话小时', 'description' => '预览外呼双方接听通话小时', 'type' => 'string', 'example' => '0'], + 'DirectObTotalCount' => ['title' => '主叫外呼总次数', 'description' => '主叫外呼总次数', 'type' => 'string', 'example' => '0'], + 'IbUniqueUnansweredCount' => ['title' => '座席来电未接听数', 'description' => '座席来电未接听数', 'type' => 'string', 'example' => '0'], + 'PreviewObTransferBridgeCount' => ['title' => '预览外呼被转接听数', 'description' => '预览外呼被转接听数', 'type' => 'string', 'example' => '1'], + 'IbTransferCount' => ['title' => '呼入转移数', 'description' => '呼入转移数', 'type' => 'string', 'example' => '2'], + 'PauseCount' => ['title' => '置忙次数', 'description' => '置忙次数', 'type' => 'string', 'example' => '1'], + 'HoursUtilization' => ['title' => '工时利用率', 'description' => '工时利用率', 'type' => 'string', 'example' => '80%'], + 'ObRealBridgeTime' => ['title' => '外呼双方接听时长', 'description' => '外呼双方接听时长', 'type' => 'string', 'example' => '00:00:10'], + 'ObCallingCount' => ['title' => '外呼呼叫次数', 'description' => '外呼呼叫次数', 'type' => 'string', 'example' => '1'], + 'IbMonitorBargeDuration' => ['title' => '呼入强插时长', 'description' => '呼入强插时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObMonitorBargeDuration' => ['title' => 'webcall强插时长', 'description' => 'webcall强插时长', 'type' => 'string', 'example' => '00:00:00'], + 'TotalBridgeTime' => ['title' => '总双方接听时长', 'description' => '总双方接听时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObMonitorSpyCount' => ['title' => 'webcall监控监听数', 'description' => 'webcall监控监听数', 'type' => 'string', 'example' => '0'], + 'DirectObValidTotalBridgeTime' => ['title' => '主叫外呼有效接听时长', 'description' => '主叫外呼有效接听时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObMonitorBargeCount' => ['title' => 'webcall监控强插数', 'description' => 'webcall监控强插数', 'type' => 'string', 'example' => '0'], + 'RowName' => ['title' => '行名称', 'description' => '行名称', 'type' => 'string', 'example' => '2017年06月13日[12345]'], + 'ObAvgBridgeTime' => ['title' => '外呼平均通话时长', 'description' => '外呼平均通话时长', 'type' => 'string', 'example' => '00:00:00'], + 'ObBridgeTime' => ['title' => '外呼总通话时长', 'description' => '外呼总通话时长', 'type' => 'string', 'example' => 'ObBridgeTime'], + 'IbHoldTime' => ['title' => '呼入总保持时长', 'description' => '呼入总保持时长', 'type' => 'string', 'example' => '00:00:00'."\n"], + 'WebcallObMonitorWhisperCount' => ['title' => 'webcall监控耳语数', 'description' => 'webcall监控耳语数', 'type' => 'string', 'example' => '0'], + 'IdleTime' => ['title' => '总空闲时长', 'description' => '总空闲时长', 'type' => 'string', 'example' => '00:00:00'."\n"], + 'ObHoldTime' => ['title' => '外呼总保持时长', 'description' => '外呼总保持时长', 'type' => 'string', 'example' => '00:00:10'."\n"], + 'IbValidTotalBridgeTime' => ['title' => '呼入有效通话时长', 'description' => '呼入有效通话时长', 'type' => 'string', 'example' => '00:00:10'."\n"], + 'IbWrapupCount' => ['title' => '呼入整理次数', 'description' => '呼入整理次数', 'type' => 'string', 'example' => '0'], + 'PreviewObCustomerRingingCount' => ['title' => '响铃数', 'description' => '响铃数', 'type' => 'string', 'example' => '1'], + 'IbAvgHoldTime' => ['title' => '呼入平均保持时长', 'description' => '呼入平均保持时长', 'type' => 'string', 'example' => '00:00:00'."\n"], + 'PreviewObCustomerAnsweredTime' => ['title' => '预览外呼客户接听时长', 'description' => '预览外呼客户接听时长', 'type' => 'string', 'example' => '00:00:00'."\n"], + 'PreviewObAgentAnsweredTime' => ['title' => '预览外呼座席接听时长', 'description' => '预览外呼座席接听时长', 'type' => 'string', 'example' => '00:00:01'."\n"], + 'PredictObAnsweredDurationArray' => ['title' => '预测外呼接听量分布', 'description' => '预测外呼接听量分布', 'type' => 'string', 'example' => '""'], + 'IbCallingCount' => ['title' => '呼入呼叫次数', 'description' => '呼入呼叫次数', 'type' => 'string', 'example' => '0'], + 'IvrTransferBridgeDuration' => ['title' => '预览外呼IVR转移双方接听时长', 'description' => '预览外呼IVR转移双方接听时长', 'type' => 'string', 'example' => '00:00:01'], + 'DirectObTotalTime' => ['title' => '主叫外呼总分钟数', 'description' => '主叫外呼总分钟数', 'type' => 'string', 'example' => '00:00:22'], + 'DateTimeRange' => ['title' => '时间范围', 'description' => '时间范围', 'type' => 'string', 'example' => '2017年06月13日'], + 'DirectObAnsweredDurationDscArray' => [ + 'title' => '主叫外呼接听量分布描述', + 'description' => '主叫外呼接听量分布描述', + 'type' => 'array', + 'items' => ['description' => '分布项', 'type' => 'string', 'example' => '0'], + 'example' => '', + ], + 'PreviewObValidTotalBridgeTime' => ['title' => '预览外呼有效总通话时长', 'description' => '预览外呼有效总通话时长', 'type' => 'string', 'example' => '00:00:22'."\n"], + 'PredictObMonitorWhisperCount' => ['title' => '预测外呼监控耳语数', 'description' => '预测外呼监控耳语数', 'type' => 'string', 'example' => '0'], + 'QueueName' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => 'name3'], + 'ObMaxWrapupTime' => ['title' => '外呼最大整理时长', 'description' => '外呼最大整理时长', 'type' => 'string', 'example' => '00:00:22'."\n"], + 'ObAvgCallingTime' => ['title' => '外呼平均呼叫时长', 'description' => '外呼平均呼叫时长', 'type' => 'string', 'example' => '00:00:11'."\n"], + 'ObMinBridgeTime' => ['title' => '外呼最小通话时长', 'description' => '外呼最小通话时长', 'type' => 'string', 'example' => '00:00:02'."\n"], + 'ObHoldCount' => ['title' => '外呼保持次数', 'description' => '外呼保持次数', 'type' => 'string', 'example' => '1'], + 'IbBridgeCount' => ['title' => '呼入通话次数', 'description' => '呼入通话次数', 'type' => 'string', 'example' => '2'], + 'PreviewObMonitorBargeDuration' => ['title' => '预览外呼强插时长', 'description' => '预览外呼强插时长', 'type' => 'string', 'example' => '00:00:00'."\n"], + 'IbAnsweredDurationDscArray' => [ + 'title' => '呼入接听量分布描述', + 'description' => '呼入接听量分布描述', + 'type' => 'array', + 'items' => ['description' => '描述项', 'type' => 'string', 'example' => '5-10分钟内，2-5分钟内'], + 'example' => '', + ], + 'CallUtilization' => ['title' => '通话利用率', 'description' => '通话利用率', 'type' => 'string', 'example' => '66%'], + 'IbMonitorWhisperDuration' => ['title' => '呼入耳语时长', 'description' => '呼入耳语时长', 'type' => 'string', 'example' => '00:00:00'], + 'DirectObValidCalls' => ['title' => '主叫外呼有效接听数', 'description' => '主叫外呼有效接听数', 'type' => 'string', 'example' => '0'], + 'DirectObMonitorBargeCount' => ['title' => '主叫外呼强插总次数', 'description' => '主叫外呼强插总次数', 'type' => 'string', 'example' => '0'], + 'IbValidCalls' => ['title' => '呼入有效通话次数', 'description' => '呼入有效通话次数', 'type' => 'string', 'example' => '0'], + 'PredictObMonitorSpyDuration' => ['title' => '预测外呼监听时长', 'description' => '预测外呼监听时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbAnsweredCount' => ['title' => '呼入座席接听数', 'description' => '呼入座席接听数', 'type' => 'string', 'example' => '0'], + 'PreviewObMonitorSpyCount' => ['title' => '预览外呼监控监听数', 'description' => '预览外呼监控监听数', 'type' => 'string', 'example' => '0'], + 'PredictObMonitorWhisperDuration' => ['title' => '预测外呼耳语时长', 'description' => '预测外呼耳语时长', 'type' => 'string', 'example' => '00:00:00'], + 'ObMaxBridgeTime' => ['title' => '外呼最大通话时长', 'description' => '外呼最大通话时长', 'type' => 'string', 'example' => '00:00:00'], + 'PreviewObValidCalls' => ['title' => '预览外呼有效通话次数', 'description' => '预览外呼有效通话次数', 'type' => 'string', 'example' => '0'], + 'ObWrapupTime' => ['title' => '外呼总整理时长', 'description' => '外呼总整理时长', 'type' => 'string', 'example' => '00:00:00'], + 'WebcallObAnsweredDurationArray' => ['title' => 'webcall接听量分布', 'description' => 'webcall接听量分布', 'type' => 'string', 'example' => '""'], + 'WebcallObMonitorThreewayCount' => ['title' => 'webcall监控三方数', 'description' => 'webcall监控三方数', 'type' => 'string', 'example' => '0'], + 'PreviewObAnsweredCount' => ['title' => '预览外呼双方接听数', 'description' => '预览外呼双方接听数', 'type' => 'string', 'example' => '0'], + 'PredictObValidCalls' => ['title' => '预测外呼有效通话数', 'description' => '预测外呼有效通话数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WebcallObAnsweredCount' => ['title' => 'webcall双方接听数', 'description' => 'webcall双方接听数', 'type' => 'string', 'example' => '0'], + 'PreviewAgentAnswerdRate' => ['title' => '预览外呼座席接听率', 'description' => '预览外呼座席接听率', 'type' => 'string', 'example' => '33%'], + 'MaxIdleTime' => ['title' => '最大空闲时长', 'description' => '最大空闲时长', 'type' => 'string', 'example' => '00:00:00'], + 'IbMaxCallingTime' => ['title' => '呼入最大呼叫时长', 'description' => '呼入最大呼叫时长', 'type' => 'string', 'example' => '00:00:10'], + 'IbUniqueTotalCount' => ['title' => '座席来电数', 'description' => '座席来电数', 'type' => 'string', 'example' => '0'], + 'IbAvgAnswerDelayTime' => ['title' => '呼入接听平均延迟时间', 'description' => '呼入接听平均延迟时间', 'type' => 'string', 'example' => '00:00:00'], + 'IvrTransferBridgeCount' => ['title' => '预览外呼IVR转移座席接听数', 'description' => '预览外呼IVR转移座席接听数', 'type' => 'string', 'example' => '0'], + ], + 'description' => '', ], + 'example' => '', ], ], ], + 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席工作量报表数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Total\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"INIT\\\\n\\",\\n \\"Data\\": \\"1\\",\\n \\"DataType\\": \\"LIST\\",\\n \\"TaskName\\": \\"验证码\\",\\n \\"CompletedCount\\": 2,\\n \\"TotalCount\\": 6,\\n \\"TemplateName\\": \\"身份验证\\",\\n \\"StopTime\\": \\"1614332378000\\",\\n \\"BizType\\": \\"VMS_TTS\\",\\n \\"Resource\\": \\"0571000****\\",\\n \\"TemplateCode\\": \\"TTS_28292****\\",\\n \\"FireTime\\": \\"1614330978000\\",\\n \\"CompleteTime\\": \\"1614330986000\\",\\n \\"CompletedRate\\": 0,\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCallTaskResponse>\\n <RequestId>5B0F201F-DCDA-45C2-AA92-1AE177F94991</RequestId>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>20</Total>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614330978000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>0fec3add-ef76-4c24-9728-666ababae9d6--alicomTask.xlsx</Data>\\n <CompletedCount>1</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>1</TotalCount>\\n <TaskName>测试任务</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>LIST</DataType>\\n <Id>1951001</Id>\\n <CompleteTime>1614330986000</CompleteTime>\\n </Data>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614159414000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>dyvms_51bae600-1e0c-4f65-9fb5-5811fd2226b7.xlsx</Data>\\n <CompletedCount>2</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>2</TotalCount>\\n <TaskName>任务中心</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>FILE</DataType>\\n <Id>195002</Id>\\n <CompleteTime>1614159424000</CompleteTime>\\n </Data>\\n <Code>200</Code>\\n</ListCallTaskResponse>","errorExample":""}]', - 'title' => '获取通话任务状态列表', - 'summary' => '创建语音通话任务后，可以查看通话任务状态，包括：任务ID、任务当前状态、任务所选的模板信息等。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。'."\n" - .'### 接口说明'."\n" - .'您也可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态，并根据需要对任务进行**启动**、**定时启动**、**编辑**、**取消任务**等操作。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"756BCB70-492E-5877-ABEB-03BB5CA28540\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"List\\": [\\n {\\n \\"IbMonitorPickupDuration\\": \\"0\\",\\n \\"DirectObAnsweredDurationArray\\": \\"0\\",\\n \\"AvgIdleTime\\": \\"00:00:01\\",\\n \\"PredictObValidTotalBridgeTime\\": 33,\\n \\"ObMinWrapupTime\\": \\"00:00:00\\",\\n \\"DirectObMonitorThreewayCount\\": \\"0\\",\\n \\"PredictObConsultCount\\": \\"0\\",\\n \\"PreviewObCustomerRingingRate\\": \\"100%\\",\\n \\"PreviewObValidTotalBridgeHour\\": \\"1\\",\\n \\"ObBridgeCount\\": \\"3\\",\\n \\"IbMonitorSpyCount\\": \\"3\\",\\n \\"PredictObMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"IbAnsweredDurationArray\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"PreviewObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"AgentAnswerRate\\": \\"80%\\",\\n \\"AgentName\\": \\"test-3\\",\\n \\"MinRestTime\\": \\"00:00:00\\",\\n \\"WebcallObTransferCount\\": \\"0\\",\\n \\"IbMinBridgeTime\\": \\"00:00:10\\\\n\\",\\n \\"IbUniqueAnsweredCount\\": \\"3\\",\\n \\"PauseTime\\": \\"00:00:10\\",\\n \\"DirectObAnsweredCount\\": \\"4\\",\\n \\"PredictObAgentAnsweredTime\\": 72,\\n \\"PreviewObMonitorDisconnectCount\\": \\"0\\",\\n \\"ObAvgWrapupTime\\": \\"00:00:05\\",\\n \\"ObAvgHoldTime\\": \\"00:00:50\\",\\n \\"IbTotalCount\\": \\"6\\",\\n \\"IbUnansweredCount\\": \\"2\\",\\n \\"DirectObMonitorWhisperCount\\": \\"0\\",\\n \\"PreviewObMonitorSpyDuration\\": \\"0\\",\\n \\"IbMonitorPickupCount\\": \\"0\\",\\n \\"IbCustomerHangupCount\\": \\"3\\",\\n \\"PreviewObAnsweredDurationDscArray\\": [\\n \\"10-30秒内\\"\\n ],\\n \\"IbAgentHangupCount\\": \\"0\\",\\n \\"PredictObMonitorSpyCount\\": \\"0\\",\\n \\"Id\\": \\"123124\\",\\n \\"PredictObAgentAnsweredHour\\": \\"1\\",\\n \\"ObWrapupCount\\": \\"3\\",\\n \\"IbMaxAnswerDelayTime\\": \\"00:00:00\\",\\n \\"PreviewObTotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"PreviewObAgentAnsweredCount\\": \\"0\\",\\n \\"IbAgentRefuseCount\\": \\"0\\",\\n \\"LoginTime\\": \\"00:00:01\\",\\n \\"DirectObConsultCount\\": \\"0\\",\\n \\"IbWrapupTime\\": \\"00:00:00\\",\\n \\"PreviewObConsultCount\\": \\"0\\",\\n \\"Cno\\": \\"1111\\",\\n \\"IbMaxWrapupTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorDisconnectCount\\": \\"0\\",\\n \\"IbMonitorThreewayCount\\": \\"0\\",\\n \\"MaxRestTime\\": \\"00:00:00\\",\\n \\"PredictObTransferCount\\": \\"0\\",\\n \\"DirectObMonitorSpyCount\\": \\"0\\",\\n \\"ObCallingTime\\": \\"00:00:00\\",\\n \\"PreviewObTransferBridgeDuration\\": \\"00:00:00\\",\\n \\"IbTotalAnswerDelayTime\\": \\"00:00:00\\",\\n \\"IbMinAnswerDelayTime\\": \\"00:00:00\\",\\n \\"PredictObMonitorBargeCount\\": \\"0\\",\\n \\"DirectObBridgeDuration\\": \\"00:00:00\\",\\n \\"IbAvgCallingTime\\": \\"00:00:00\\",\\n \\"IbMaxBridgeTime\\": \\"00:00:00\\",\\n \\"PreviewObTotalCount\\": \\"0\\",\\n \\"PreviewObMonitorThreewayCount\\": \\"0\\",\\n \\"DirectObTransferCount\\": \\"0\\",\\n \\"PredictObTotalCount\\": 39,\\n \\"IbCallingTime\\": \\"00:00:00\\",\\n \\"IbMonitorBargeCount\\": \\"0\\",\\n \\"WebcallObAgentAnsweredTime\\": \\"00:00:00\\",\\n \\"RestTime\\": \\"00:00:00\\",\\n \\"PredictObValidTotalBridgeHour\\": \\"0\\",\\n \\"IbConsultCount\\": \\"0\\",\\n \\"IbBridgeMinute\\": \\"00:00:00\\",\\n \\"PredictObMonitorDisconnectCount\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"PreviewObAnsweredDurationArray\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"AgentRate\\": \\"0%\\",\\n \\"WebcallObTotalCount\\": \\"0\\",\\n \\"IbTotalMinute\\": \\"0\\",\\n \\"MinIdleTime\\": \\"00:00:01\\",\\n \\"PreviewObMonitorBargeCount\\": \\"0\\",\\n \\"AgentStopTime\\": \\"00:00:01\\",\\n \\"IbBridgeTime\\": \\"00:00:00\\",\\n \\"IbMinHoldTime\\": \\"00:00:00\\",\\n \\"IbMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"IbMonitorDisconnectCount\\": \\"0\\",\\n \\"DirectObBridgeTime\\": \\"00:00:00\\",\\n \\"ObMinHoldTime\\": \\"00:00:00\\",\\n \\"WebcallObConsultCount\\": \\"0\\",\\n \\"IbMinCallingTime\\": \\"00:00:00\\",\\n \\"Day\\": \\"2026-04-20\\",\\n \\"MinPauseTime\\": \\"00:00:00\\",\\n \\"IbMinWrapupTime\\": \\"00:00:00\\",\\n \\"RestCount\\": \\"0\\",\\n \\"IbAvgBridgeTime\\": \\"00:00:00\\",\\n \\"ObMaxHoldTime\\": \\"00:00:01\\",\\n \\"IbHoldCount\\": \\"0\\",\\n \\"WebcallObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"AvgPreviewObWaitTime\\": \\"00:00:00\\",\\n \\"PreviewCustomerAnswerdRate\\": \\"0%\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"PredictObAnsweredCount\\": 27,\\n \\"IbMonitorWhisperCount\\": \\"0\\",\\n \\"PreviewObMonitorWhisperCount\\": \\"0\\",\\n \\"IvrTransferCount\\": \\"0\\",\\n \\"DirectObMonitorDisconnectCount\\": \\"0\\",\\n \\"MaxPauseTime\\": \\"00:00:00\\",\\n \\"IbMaxHoldTime\\": \\"00:00:00\\",\\n \\"IbAvgWrapupTime\\": \\"00:00:10\\",\\n \\"PredictObMonitorThreewayCount\\": \\"1\\",\\n \\"PreviewObTransferCount\\": \\"1\\",\\n \\"ObMinCallingTime\\": \\"0\\",\\n \\"AvgRestTime\\": \\"00:00:03\\",\\n \\"IdleCount\\": \\"0\\",\\n \\"AvgPauseTime\\": \\"00:00:00\\",\\n \\"ObMaxCallingTime\\": \\"00:00:03\\",\\n \\"IbTotalTime\\": \\"3\\",\\n \\"AgentCreateTime\\": \\"2019-04-20\\",\\n \\"PreviewObTotalBridgeHour\\": \\"0\\",\\n \\"DirectObTotalCount\\": \\"0\\",\\n \\"IbUniqueUnansweredCount\\": \\"0\\",\\n \\"PreviewObTransferBridgeCount\\": \\"1\\",\\n \\"IbTransferCount\\": \\"2\\",\\n \\"PauseCount\\": \\"1\\",\\n \\"HoursUtilization\\": \\"80%\\",\\n \\"ObRealBridgeTime\\": \\"00:00:10\\",\\n \\"ObCallingCount\\": \\"1\\",\\n \\"IbMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"WebcallObMonitorBargeDuration\\": \\"00:00:00\\",\\n \\"TotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorSpyCount\\": \\"0\\",\\n \\"DirectObValidTotalBridgeTime\\": \\"00:00:00\\",\\n \\"WebcallObMonitorBargeCount\\": \\"0\\",\\n \\"RowName\\": \\"2017年06月13日[12345]\\",\\n \\"ObAvgBridgeTime\\": \\"00:00:00\\",\\n \\"ObBridgeTime\\": \\"ObBridgeTime\\",\\n \\"IbHoldTime\\": \\"00:00:00\\\\n\\",\\n \\"WebcallObMonitorWhisperCount\\": \\"0\\",\\n \\"IdleTime\\": \\"00:00:00\\\\n\\",\\n \\"ObHoldTime\\": \\"00:00:10\\\\n\\",\\n \\"IbValidTotalBridgeTime\\": \\"00:00:10\\\\n\\",\\n \\"IbWrapupCount\\": \\"0\\",\\n \\"PreviewObCustomerRingingCount\\": \\"1\\",\\n \\"IbAvgHoldTime\\": \\"00:00:00\\\\n\\",\\n \\"PreviewObCustomerAnsweredTime\\": \\"00:00:00\\\\n\\",\\n \\"PreviewObAgentAnsweredTime\\": \\"00:00:01\\\\n\\",\\n \\"PredictObAnsweredDurationArray\\": \\"\\\\\\"\\\\\\"\\",\\n \\"IbCallingCount\\": \\"0\\",\\n \\"IvrTransferBridgeDuration\\": \\"00:00:01\\",\\n \\"DirectObTotalTime\\": \\"00:00:22\\",\\n \\"DateTimeRange\\": \\"2017年06月13日\\",\\n \\"DirectObAnsweredDurationDscArray\\": [\\n \\"0\\"\\n ],\\n \\"PreviewObValidTotalBridgeTime\\": \\"00:00:22\\\\n\\",\\n \\"PredictObMonitorWhisperCount\\": \\"0\\",\\n \\"QueueName\\": \\"name3\\",\\n \\"ObMaxWrapupTime\\": \\"00:00:22\\\\n\\",\\n \\"ObAvgCallingTime\\": \\"00:00:11\\\\n\\",\\n \\"ObMinBridgeTime\\": \\"00:00:02\\\\n\\",\\n \\"ObHoldCount\\": \\"1\\",\\n \\"IbBridgeCount\\": \\"2\\",\\n \\"PreviewObMonitorBargeDuration\\": \\"00:00:00\\\\n\\",\\n \\"IbAnsweredDurationDscArray\\": [\\n \\"5-10分钟内，2-5分钟内\\"\\n ],\\n \\"CallUtilization\\": \\"66%\\",\\n \\"IbMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"DirectObValidCalls\\": \\"0\\",\\n \\"DirectObMonitorBargeCount\\": \\"0\\",\\n \\"IbValidCalls\\": \\"0\\",\\n \\"PredictObMonitorSpyDuration\\": \\"00:00:00\\",\\n \\"IbAnsweredCount\\": \\"0\\",\\n \\"PreviewObMonitorSpyCount\\": \\"0\\",\\n \\"PredictObMonitorWhisperDuration\\": \\"00:00:00\\",\\n \\"ObMaxBridgeTime\\": \\"00:00:00\\",\\n \\"PreviewObValidCalls\\": \\"0\\",\\n \\"ObWrapupTime\\": \\"00:00:00\\",\\n \\"WebcallObAnsweredDurationArray\\": \\"\\\\\\"\\\\\\"\\",\\n \\"WebcallObMonitorThreewayCount\\": \\"0\\",\\n \\"PreviewObAnsweredCount\\": \\"0\\",\\n \\"PredictObValidCalls\\": 0,\\n \\"WebcallObAnsweredCount\\": \\"0\\",\\n \\"PreviewAgentAnswerdRate\\": \\"33%\\",\\n \\"MaxIdleTime\\": \\"00:00:00\\",\\n \\"IbMaxCallingTime\\": \\"00:00:10\\",\\n \\"IbUniqueTotalCount\\": \\"0\\",\\n \\"IbAvgAnswerDelayTime\\": \\"00:00:00\\",\\n \\"IvrTransferBridgeCount\\": \\"0\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ExecuteCallTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudAssignAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1042,296 +1359,640 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '77094', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。通过[CreateCallTask](~~CreateCallTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2256****', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'Status', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => '任务启动状态。取值：'."\n" - ."\n" - .'- **RUNNING**：立即启动。'."\n" - .'- **STOP**：停止任务。'."\n" - .'- **CANCEL**：取消任务。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RUNNING', - ], + 'schema' => ['title' => '外呼组编号；说明：添加此gno对应的外呼组与cnos对应的座席的绑定从属关系; 同一外呼组最多可包含1000个座席', 'description' => '外呼组编号；说明：添加此gno对应的外呼组与cnos对应的座席的绑定从属关系; 同一外呼组最多可包含1000个座席', 'type' => 'string', 'required' => false, 'example' => 'WH123'], ], [ - 'name' => 'FireTime', + 'name' => 'Cnos', 'in' => 'query', - 'schema' => [ - 'description' => '定时启动时间。格式为：yyyy-MM-dd HH:mm:ss。'."\n" - ."\n\n" - .'> 如果此处为空，则不用填写该字段。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-03-09 00:00:00', - ], + 'schema' => ['title' => '说明：多个座席编号之间以英文逗号( , )分隔，一次最多支持1000个cno；同一座席只能存在于一个外呼组，重复分配会自动移动到新的外呼组中', 'description' => '说明：多个座席编号之间以英文逗号( , )分隔，一次最多支持1000个cno；同一座席只能存在于一个外呼组，重复分配会自动移动到新的外呼组中', 'type' => 'string', 'required' => false, 'example' => '1000,1111'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '状态码。', - 'type' => 'string', - 'example' => '200', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功'."\n" - .'- **false**：失败', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，1-失败', 'description' => '0-成功，1-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '外呼组分配座席', + 'summary' => '通过本接口，可以将座席分配到外呼组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecuteCallTaskResponse>\\n <Code>200</Code>\\n <Data>true</Data>\\n <RequestId>53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD</RequestId>\\n</ExecuteCallTaskResponse>","errorExample":""}]', - 'title' => '执行语音通话任务', - 'summary' => '执行通话任务。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListCallTaskDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudBatchCreateAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '任务ID。'."\n" - ."\n" - .'- 通过[CreateCallTask接口](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.4b0a7be3m1G1Kx)获取任务ID。'."\n" - ."\n" - .'- 在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)任务中心页面获取任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '18908**', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'CalledNum', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '1390000****', - ], + 'schema' => ['title' => '开始座席工号；正整数，取值3-10位数字', 'description' => '开始座席工号；正整数，取值3-10位数字', 'type' => 'string', 'required' => true, 'example' => '100'], ], [ - 'name' => 'Status', + 'name' => 'EndCno', + 'in' => 'query', + 'schema' => ['title' => '结束座席工号；正整数，取值3-10位数字，单次批量创建不能超过100个', 'description' => '结束座席工号；正整数，取值3-10位数字，单次批量创建不能超过100个', 'type' => 'string', 'required' => true, 'example' => '103'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'description' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => true, 'example' => '李四'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '座席所属区号；区号格式', 'description' => '座席所属区号', 'type' => 'string', 'required' => true, 'example' => '010'], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['title' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'description' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Power', + 'in' => 'query', + 'schema' => ['title' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'description' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '整理时间；单位秒数，默认10秒', 'description' => '整理时间；单位秒数，默认10秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼；取值说明 0：不允许，1：可以，默认允许', 'description' => '是否允许外呼；取值说明 0：不允许，1：可以，默认允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['title' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'description' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['title' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'description' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'type' => 'string', 'required' => false, 'example' => '22223333'], + ], + [ + 'name' => 'ObClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号', 'description' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'description' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'description' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SkillIds', + 'in' => 'query', + 'schema' => ['title' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；传入skillIds时，需要同时传入skillLevels', 'description' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；传入skillIds时，需要同时传入skillLevels', 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + ], + [ + 'name' => 'SkillLevels', 'in' => 'query', + 'schema' => ['title' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'description' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'type' => 'string', 'required' => false, 'example' => '5,1,1'], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['title' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['title' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'description' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['title' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '示例值'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务状态。取值：'."\n" - ."\n" - .'- **SUCCESS**：外呼成功。'."\n" - .'- **FAIL**：外呼失败。'."\n" - .'- **INIT**：未开始外呼。', - 'type' => 'string', - 'required' => false, - 'example' => 'SUCCESS', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '创建座席成功数量', 'description' => '创建座席成功数量', 'type' => 'string', 'example' => '4'], + 'Cnos' => ['title' => '成功创建的座席号', 'description' => '成功创建的座席号', 'type' => 'string', 'example' => '100,101,102,103'], + 'Fail' => ['title' => '创建座席失败数量', 'description' => '创建座席失败数量', 'type' => 'string', 'example' => '0'], + 'Other' => ['title' => '座席创建成功,绑定技能失败的数量', 'description' => '座席创建成功,绑定技能失败的数量', 'type' => 'string', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席批量新增', + 'summary' => '批量新增座席,单次批量创建不能超过100个。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"4\\",\\n \\"Cnos\\": \\"100,101,102,103\\",\\n \\"Fail\\": \\"0\\",\\n \\"Other\\": \\"0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudBatchGetAgentStatus' => [ + 'summary' => '根据座席工号批量获取座席实时状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席号列表；座席号之间用`,`分隔，如：cnos=2000,20001 最多支持100个座席', 'description' => '座席号列表；座席号之间用`,`分隔，如：cnos=2000,2001 最多支持100个座席', 'type' => 'string', 'required' => true, 'example' => '2000,2001'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '当前页码。默认值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'State' => ['title' => '座席状态描述（结合了登录状态和设备状态），离线，空闲，置忙，整理，呼叫中，响铃，保持，通话', 'description' => '座席状态描述（结合了登录状态和设备状态），离线，空闲，置忙，整理，呼叫中，响铃，保持，通话', 'type' => 'string', 'example' => '空闲'], + 'StateAction' => ['title' => '状态对应的动作，座席登录状态不是离线时返回。详见[座席状态动作说明](../../工具条/座席状态动作.md)', 'description' => '状态对应的动作，座席登录状态不是离线时返回。', 'type' => 'string', 'example' => 'Idle'], + 'LoginStatus' => ['title' => '座席登录状态 0：离线状态 1：在线状态 2：置忙状态 3：整理状态', 'description' => '座席登录状态 0：离线状态 1：在线状态 2：置忙状态 3：整理状态', 'type' => 'string', 'example' => '1'], + 'DeviceStatus' => ['title' => '座席设备状态，座席登录状态不是离线时返回 -1：错误的状态 0：空闲状态 1：锁定状态 2：邀请中状态 3：响铃状态 4：使用中状态', 'description' => '座席设备状态，座席登录状态不是离线时返回 -1：错误的状态 0：空闲状态 1：锁定状态 2：邀请中状态 3：响铃状态 4：使用中状态', 'type' => 'string', 'example' => '0'], + 'MainUniqueId' => ['title' => '座席当前参与的通话唯一标识，座席设备状态为1/2/3/4时返回', 'description' => '座席当前参与的通话唯一标识，座席设备状态为1/2/3/4时返回', 'type' => 'string', 'example' => 'test3321.sip33'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席实时状态批量获取', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"State\\": \\"空闲\\",\\n \\"StateAction\\": \\"Idle\\",\\n \\"LoginStatus\\": \\"1\\",\\n \\"DeviceStatus\\": \\"0\\",\\n \\"MainUniqueId\\": \\"test3321.sip33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudBatchUpdateAgent' => [ + 'summary' => '批量更新座席基本信息，不包含座席绑定的技能信息的更新。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席工号列表；需要批量更新座席的工号列表，多个之间使用英文标点逗号间隔，最多支持100个座席的批量更新。例如："0001,0002,00103"；座席工号，正整数，取值3-10位数字', 'description' => '座席工号列表；需要批量更新座席的工号列表，多个之间使用英文标点逗号间隔，最多支持100个座席的批量更新。例如："0001,0002,00103"；座席工号，正整数，取值3-10位数字', 'type' => 'string', 'required' => true, 'example' => '0001,0002,00103'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'description' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => false, 'example' => '李四'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '座席所属区号；区号格式', 'description' => '座席所属区号', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['title' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'description' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => ['title' => '座席类型；取值1或2，取值说明 1：电话座席，2：电脑座席，默认电话座席', 'description' => '座席类型；取值1或2，取值说明 1：电话座席，2：电脑座席，默认电话座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Power', + 'in' => 'query', + 'schema' => ['title' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'description' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '整理时间；单位秒数，默认10秒', 'description' => '整理时间；单位秒数，默认10秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼；取值说明 0：不允许，1：可以，默认允许', 'description' => '是否允许外呼；取值说明 0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['title' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'description' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['title' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'description' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'type' => 'string', 'required' => false, 'example' => '22223333'], + ], + [ + 'name' => 'IsRandom', + 'in' => 'query', + 'schema' => ['title' => '随机外显；取值说明 0:否，1:是。当obClidType值为4时需要传值，默认值为0', 'description' => '随机外显；取值说明 0:否，1:是。当obClidType值为4时需要传值，默认值为0', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'description' => '呼入是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'description' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['title' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['title' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'description' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号（注意：json格式数据需要URLencode）', 'description' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号（注意：json格式数据需要URLencode）', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}'], + ], + [ + 'name' => 'WebrtcUrlType', 'in' => 'query', + 'schema' => ['title' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsObRemember', + 'in' => 'query', + 'schema' => ['title' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'description' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => 'example'], + ], + [ + 'name' => 'PermitObPreviewTime', + 'in' => 'query', + 'schema' => ['title' => '可外呼时间段；格式：08:00,20:00', 'description' => '可外呼时间段；格式：08:00,20:00', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页显示的任务个数。默认值为**10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Success' => ['title' => '座席配置信息修改成功数量', 'description' => '座席配置信息修改成功数量', 'type' => 'string', 'example' => '3'], + 'Fail' => ['title' => '座席配置信息修改失败的座席工号列表', 'description' => '座席配置信息修改失败的座席工号列表', 'type' => 'string', 'example' => 'null'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席批量更新', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"3\\",\\n \\"Fail\\": \\"null\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAgent' => [ + 'summary' => '创建一个座席。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号；正整数，取值3-10位数字', 'description' => '座席工号；正整数，取值3-10位数字', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'description' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => true, 'example' => '张三'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '座席所属区号；区号格式', 'description' => '座席所属区号', 'type' => 'string', 'required' => true, 'example' => '010'], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['title' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'description' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Power', + 'in' => 'query', + 'schema' => ['title' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'description' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '整理时间；单位秒数，默认10秒', 'description' => '整理时间；单位秒数，默认10秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼；取值说明 0：不允许，1：可以，默认允许', 'description' => '是否允许外呼；取值说明 0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['title' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'description' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['title' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'description' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'type' => 'string', 'required' => false, 'example' => '22223333'], + ], + [ + 'name' => 'ObClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号 ;isRandom 随机外显', 'description' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号 ;isRandom 随机外显', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'description' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'description' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SkillIds', + 'in' => 'query', + 'schema' => ['title' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；传入skillIds时，需要同时传入skillLevels', 'description' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；传入skillIds时，需要同时传入skillLevels', 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + ], + [ + 'name' => 'SkillLevels', + 'in' => 'query', + 'schema' => ['title' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'description' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'type' => 'string', 'required' => false, 'example' => '5,1,1'], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['title' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['title' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'description' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['title' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsObRemember', + 'in' => 'query', + 'schema' => ['title' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'description' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '备注'], + ], + [ + 'name' => 'PermitObPreviewTime', + 'in' => 'query', + 'schema' => ['title' => '可外呼时间段；格式：08:00,20:00', 'description' => '可外呼时间段；格式：08:00,20:00', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D692AC3D-CBA8-417F-BEB9-5B73718922D4', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'TotalPage' => [ - 'description' => '总页数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页显示的任务个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Total' => [ - 'description' => '被叫号码总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回结果的提示信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '任务详情。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '任务状态。取值：'."\n" - ."\n" - .'- **SUCCESS**：外呼成功。'."\n" - .'- **FAIL**：外呼失败。'."\n" - .'- **INIT**：未外呼。', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Duration' => [ - 'description' => '通话时长。单位：秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CalledNum' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'example' => '1390000****', - ], - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'example' => '0571000****', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'title' => '座席配置信息', + 'description' => '座席配置信息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '座席状态，0:离线，1：在线', 'description' => '座席状态，0:离线，1：在线', 'type' => 'string', 'example' => '0'], + 'IsQualityCheck' => ['description' => '是否开启座席质检，取值说明：0：不开启，1：开启，默认开启', 'type' => 'string', 'example' => '1'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '0'], + 'ObClid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => 'xxxxxxxx'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-01-30 08:00:00'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'BindTelType' => ['title' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'description' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'type' => 'string', 'example' => '1'], + 'Wrapup' => ['title' => '整理时间，秒数，默认10秒', 'description' => '整理时间，秒数，默认10秒', 'type' => 'string', 'example' => '10'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'example' => '张三'], + 'IsAsr' => ['title' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'type' => 'string', 'example' => '0'], + 'Active' => ['title' => '是否启用，0：停用，1：启用，默认启用', 'description' => '是否启用，0：停用，1：启用，默认启用', 'type' => 'string', 'example' => '1'], + 'ObClidType' => ['title' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'description' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'type' => 'string', 'example' => '1'], + 'WebrtcUrlType' => ['title' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'string', 'example' => '0'], + 'AreaCode' => ['title' => '区号格式', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'ObClidProperty' => ['title' => '外显规则属性，JSON格式', 'description' => '外显规则属性，JSON格式', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}'], + 'BindTel' => ['title' => '座席绑定电话', 'description' => '座席绑定电话', 'type' => 'string', 'example' => '2222333'], + 'Id' => ['title' => '座席id', 'description' => '座席id', 'type' => 'string', 'example' => '355'], + 'Power' => ['title' => '1：班长席，0：普通座席，默认普通座席', 'description' => '1：班长席，0：普通座席，默认普通座席', 'type' => 'string', 'example' => '0'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], ], - 'Id' => [ - 'description' => '操作ID。此参数暂时不可用。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43085***', + 'example' => '', + ], + 'AgentSkills' => [ + 'title' => '座席所需技能数组', + 'description' => '座席技能数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'string', 'example' => '2'], + 'Cno' => ['description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-01-30 08:00:00'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'string', 'example' => '233'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'string', 'example' => '355'], + 'AgentId' => ['title' => '座席id', 'description' => '座席id', 'type' => 'string', 'example' => '2333'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + ], + 'description' => '', ], + 'example' => '', ], ], ], + 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D692AC3D-CBA8-417F-BEB9-5B73718922D4\\",\\n \\"Code\\": \\"OK\\",\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Duration\\": 10,\\n \\"CalledNum\\": \\"1390000****\\",\\n \\"Caller\\": \\"0571000****\\",\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCallTaskDetailResponse>\\n <RequestId>7C943A5D-E12A-4184-A5F8-CF57B92815E3</RequestId>\\n <TotalPage>500</TotalPage>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1000</Total>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1300001****</CalledNum>\\n </Data>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1310000****</CalledNum>\\n </Data>\\n <Code>OK</Code>\\n</ListCallTaskDetailResponse>","errorExample":""}]', - 'title' => '获取通话任务详情列表', - 'summary' => '执行完通话任务后根据任务ID，查看指定任务详情。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。'."\n" - .'### 接口说明'."\n" - .'您还可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，单击操作栏**任务详情**，查看通话任务详情。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'AddVirtualNumberRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建座席', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": {\\n \\"Status\\": \\"0\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"0\\",\\n \\"ObClid\\": \\"xxxxxxxx\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-01-30 08:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"张三\\",\\n \\"IsAsr\\": \\"0\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"0\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1,\\\\\\"isRandom\\\\\\":1}\\",\\n \\"BindTel\\": \\"2222333\\",\\n \\"Id\\": \\"355\\",\\n \\"Power\\": \\"0\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"AgentSkills\\": [\\n {\\n \\"SkillLevel\\": \\"2\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-01-30 08:00:00\\",\\n \\"SkillId\\": \\"233\\",\\n \\"Id\\": \\"355\\",\\n \\"AgentId\\": \\"2333\\",\\n \\"EnterpriseId\\": \\"7000002\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAgentGroup' => [ + 'summary' => '通过本接口，可以进行新增外呼组操作。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1339,1135 +2000,2707 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52666', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsT3BNLH', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['title' => '说明：同一企业外呼组编号编号不能重复，外呼组编号长度为2-20，以字母开头,须同时且只能包含字母和数字 同一企业最多可创建1000个外呼组', 'description' => '说明：同一企业外呼组编号不能重复，外呼组编号长度为2-20，以字母开头，须同时且只能包含字母和数字，同一企业最多可创建1000个外呼组。', 'type' => 'string', 'required' => true, 'example' => 'WH12'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['title' => '说明：外呼组名称不能为空，长度不能大于50,需进行UTF-8格式的URLEncode编码', 'description' => '说明：外呼组名称不能为空，长度不能大于50,需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => true, 'example' => 'gpname1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '说明：描述长度不能大于100,需进行UTF-8格式的URLEncode编码', 'description' => '说明：描述长度不能大于100,需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => false, 'example' => 'comment3'], ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '外呼组名称', 'description' => '外呼组名称', 'type' => 'string', 'example' => 'gpname1'], + 'Comment' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'comment3'], + 'Type' => ['title' => '外呼组类型 1：外呼总组 2：外呼组', 'description' => '外呼组类型 1：外呼总组 2：外呼组', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Gno' => ['title' => '外呼组编号', 'description' => '外呼组编号', 'type' => 'string', 'example' => 'WH12'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增外呼组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"gpname1\\",\\n \\"Comment\\": \\"comment3\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"WH12\\",\\n \\"EnterpriseId\\": 7000002\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateAsr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => ['title' => '通话类型；1:呼入,2:webcall,4:预览外呼,5:预测外呼,6:主叫外呼,9:内部呼叫', 'description' => '通话类型；1:呼入,2:webcall,4:预览外呼,5:预测外呼,6:主叫外呼,9:内部呼叫', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'RecordFile', + 'in' => 'query', + 'schema' => ['title' => '录音文件名；例: 7000002-20170320140327-1581-1500-record-sip-2-148998.366', 'description' => '录音文件名；例: 7000002-20170320140327-1581-1500-record-sip-2-148998.366', 'type' => 'string', 'required' => true, 'example' => ' 7000002-20170320140327-1581-1500-record-sip-2-148998.366'], + ], + [ + 'name' => 'RecordType', + 'in' => 'query', + 'schema' => ['title' => '语音文件类型,取值：record,voicemail 说明：record是录音， voicemail是留言', 'description' => '语音文件类型,取值：record,voicemail 说明：record是录音， voicemail是留言', 'type' => 'string', 'required' => true, 'example' => 'record'], + ], + [ + 'name' => 'RecordSide', + 'in' => 'query', + 'schema' => ['title' => '录音通道类型；取值范围：0：混音 1：分线录音时客户侧,2：分线录音时座席侧,3:分线录音时客户侧和座席侧', 'description' => '录音通道类型；取值范围：0：混音 1：分线录音时客户侧,2：分线录音时座席侧,3:分线录音时客户侧和座席侧', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '从通道的唯一标识', 'description' => '从通道的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1489989807.36601'], + ], + [ + 'name' => 'MainUniqueId', 'in' => 'query', + 'schema' => ['title' => '主通道的唯一标识', 'description' => '主通道的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1489989807.36601'], + ], + [ + 'name' => 'SupportMp3', + 'in' => 'query', + 'schema' => ['title' => '当wav过期时，是否支持使用mp3进行转写；0-不支持（默认）；1-代表支持，如果通话wav过期，则自动使用mp3转写，转写结果中通道类型会被设置为混音类型；混音mp3无法区分两侧，双声道mp3可以区分两侧内容', 'description' => '当wav过期时，是否支持使用mp3进行转写；0-不支持（默认）；1-代表支持，如果通话wav过期，则自动使用mp3转写，转写结果中通道类型会被设置为混音类型；混音mp3无法区分两侧，双声道mp3可以区分两侧内容', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品名称。默认取值：**dyvms**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dyvms', - 'default' => 'dyvmsapi', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建ASR转换任务', + 'summary' => '上传录音文件，创建ASR创建转换任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateEnterpriseTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CorpNameList', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '时间条件名称；同一呼叫中心下不能重复', 'description' => '时间条件名称；同一呼叫中心下不能重复', 'type' => 'string', 'required' => true, 'example' => 'demo01'], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['title' => '时间条件优先级；同一呼叫中心下不能重复，值从1开始，值越小优先级越高', 'description' => '时间条件优先级；同一呼叫中心下不能重复，值从1开始，值越小优先级越高', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '条件类型 1:按照星期配置 2:按照固定时间配置', 'description' => '条件类型 1:按照星期配置 2:按照固定时间配置', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'TimeType', + 'in' => 'query', + 'schema' => ['title' => '时间类型 1.连续 2.间隔', 'description' => '时间类型 1.连续 2.间隔', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'FromDay', + 'in' => 'query', + 'schema' => ['title' => '起始日期；当type=2 时必选，格式为：yyyy-MM-dd 、type=1时为空串 fromDay不能大于toDay', 'description' => '起始日期；当type=2 时必选，格式为：yyyy-MM-dd 、type=1时为空串 fromDay不能大于toDay', 'type' => 'string', 'required' => false, 'example' => '2026-04-20'], + ], + [ + 'name' => 'ToDay', 'in' => 'query', + 'schema' => ['title' => '终止日期；当type=2 时必选，格式为：yyyy-MM-dd 、type=1时为空串 fromDay不能大于toDay', 'description' => '终止日期；当type=2 时必选，格式为：yyyy-MM-dd 、type=1时为空串 fromDay不能大于toDay', 'type' => 'string', 'required' => false, 'example' => '2026-04-25'], + ], + [ + 'name' => 'DayOfWeek', + 'in' => 'query', + 'schema' => ['title' => '当type=1 时必选,周一：2、周二：3、周三：4、周四：5、周五：6、周六：7、周日：1。星期值以,分隔 例如： 2,3,4代表周一周二周三、type=2时为空串', 'description' => '当type=1 时必选,周一：2、周二：3、周三：4、周四：5、周五：6、周六：7、周日：1。星期值以,分隔 例如： 2,3,4代表周一周二周三、type=2时为空串', 'type' => 'string', 'required' => false, 'example' => '2,3,4'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '开始时间；格式为 HH:mm 例如、 06:00 startTime不能大于endTime', 'description' => '开始时间；格式为 HH:mm 例如、 06:00 startTime不能大于endTime', 'type' => 'string', 'required' => true, 'example' => '06:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '结束时间；格式为 HH:mm 例如、 19:00 startTime不能大于endTime', 'description' => '结束时间；格式为 HH:mm 例如、 19:00 startTime不能大于endTime', 'type' => 'string', 'required' => true, 'example' => '19:00'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '公司名列表。多个公司之间用半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '公司1,公司2', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DayOfWeek' => ['title' => '星期 周一：2、周二：3、周三：4、周四：5、周五：6、周六：7、周日：1、使用","进行分割、type=2时为空串', 'description' => '星期 周一：2、周二：3、周三：4、周四：5、周五：6、周六：7、周日：1、使用","进行分割、type=2时为空串', 'type' => 'string', 'example' => '2,3,4'], + 'Type' => ['title' => '时间条件类型 1:按照星期配置 2:按照固定时间配置', 'description' => '时间条件类型 1:按照星期配置 2:按照固定时间配置', 'type' => 'string', 'example' => '1'], + 'ToDay' => ['title' => '终止日期 格式为：yyyy-MM-dd、type=1时为空串 fromDay不能大于toDay', 'description' => '终止日期 格式为：yyyy-MM-dd、type=1时为空串 fromDay不能大于toDay', 'type' => 'string', 'example' => '2026-04-25'], + 'EndTime' => ['title' => '结束时间 格式为 HH:mm startTime不能大于endTime', 'description' => '结束时间 格式为 HH:mm startTime不能大于endTime', 'type' => 'string', 'example' => '19:00'."\n"], + 'Priority' => ['title' => '优先级、同一呼叫中心下不能重复，值从1开始，值越小优先级越高', 'description' => '优先级、同一呼叫中心下不能重复，值从1开始，值越小优先级越高', 'type' => 'string', 'example' => '1'], + 'CreateTime' => ['title' => '创建时间，格式为： yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'StartTime' => ['title' => '开始时间 格式为 HH:mm startTime不能大于endTime', 'description' => '开始时间 格式为 HH:mm startTime不能大于endTime', 'type' => 'string', 'example' => '06:00'."\n"], + 'FromDay' => ['title' => '起始日期 格式为：yyyy-MM-dd、type=1时为空串 fromDay不能大于toDay', 'description' => '起始日期 格式为：yyyy-MM-dd、type=1时为空串 fromDay不能大于toDay', 'type' => 'string', 'example' => '2026-04-20'], + 'Id' => ['title' => '时间条件id', 'description' => '时间条件id', 'type' => 'string', 'example' => '236'], + 'EnterpriseId' => ['title' => '呼叫中心编号', 'description' => '呼叫中心编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '时间条件名称 、同一呼叫中心下不能重复', 'description' => '时间条件名称 、同一呼叫中心下不能重复', 'type' => 'string', 'example' => 'demo01'], + 'TimeType' => ['title' => '时间类型 1.连续 2.间隔', 'description' => '时间类型 1.连续 2.间隔', 'type' => 'string', 'example' => '1'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增时间条件设置', + 'summary' => '通过本接口，可以新增时间条件设置配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"DayOfWeek\\": \\"2,3,4\\",\\n \\"Type\\": \\"1\\",\\n \\"ToDay\\": \\"2026-04-25\\",\\n \\"EndTime\\": \\"19:00\\\\n\\",\\n \\"Priority\\": \\"1\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"StartTime\\": \\"06:00\\\\n\\",\\n \\"FromDay\\": \\"2026-04-20\\",\\n \\"Id\\": \\"236\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"demo01\\",\\n \\"TimeType\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'NumberList', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['title' => '分机号,3-11位', 'description' => '分机号,3-11位', 'type' => 'string', 'required' => true, 'example' => '9000'], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'required' => true, 'example' => 'Aa248236'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限；0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限；0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼；0：不允许，1：可以，默认允许', 'description' => '是否允许外呼；0：不允许，1：允许，默认允许', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsDirect', + 'in' => 'query', + 'schema' => ['title' => '是否允许摘机外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许摘机外呼，0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音；0：不录用，1：录音，默认录音', 'description' => '呼入是否录音；0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音；0：不录音，1：录音，默认录音', 'description' => '外呼是否录音；0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'required' => true, 'example' => '010'], + ], + [ + 'name' => 'JitterBuffer', + 'in' => 'query', + 'schema' => ['title' => '网络防抖；0：关闭，1：开启，默认关闭', 'description' => '网络防抖；0：关闭，1：开启，默认关闭', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '类型；1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'description' => '类型；1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'Allow', + 'in' => 'query', + 'schema' => ['title' => '允许的语音编码,支持格式: 1. g729 2. g729,alaw,ulaw 3. alaw,ulaw,g729 4. alaw,ulaw 5. myopus,alaw,ulaw5. myopus,alaw,ulaw6. myopus,g729,alaw,ulaw 7. myopus,g729 公网+远程话机支持配置1/2/3;专线+远程话机支持配置1/2;公网+软电话支持配置4;专线+软电话支持配置5;', 'description' => '允许的语音编码,支持格式: 1. g729 2. g729,alaw,ulaw 3. alaw,ulaw,g729 4. alaw,ulaw 5. myopus,alaw,ulaw5. myopus,alaw,ulaw6. myopus,g729,alaw,ulaw 7. myopus,g729 公网+远程话机支持配置1/2/3;专线+远程话机支持配置1/2;公网+软电话支持配置4;专线+软电话支持配置5;', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IadName', + 'in' => 'query', + 'schema' => ['title' => 'iad网关；该参数只有在类型为，注册到IAD分机，才有效', 'description' => 'iad网关；该参数只有在类型为，注册到IAD分机，才有效', 'type' => 'string', 'required' => false, 'example' => '""'], + ], + [ + 'name' => 'Property', + 'in' => 'query', + 'schema' => ['title' => '属性', 'description' => '属性', 'type' => 'string', 'required' => false, 'example' => '{}'], + ], + [ + 'name' => 'Denoise', + 'in' => 'query', + 'schema' => ['title' => '降噪开关；0:关闭 1:开启 (该参数只有在类型为注册到webrtc才有效)', 'description' => '降噪开关；0:关闭 1:开启 (该参数只有在类型为注册到webrtc才有效)', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '真实号码列表。多个号码之间使用半角逗号（,）分隔。 您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的真实号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1321111****,1322222****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '本组参数已弃用，请忽略。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-03-30 06:09:04'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Exten' => ['title' => '分机号,3-11位', 'description' => '分机号,3-11位', 'type' => 'string', 'example' => '9000'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'BindGatewayId' => ['title' => '绑定的agent-gateway', 'description' => '绑定的agent-gateway', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], + 'Allow' => ['title' => '语音编码', 'description' => '语音编码', 'type' => 'string', 'example' => 'alaw,ulaw'], + 'Type' => ['title' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'description' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AreaCode' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'Denoise' => ['title' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'description' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Id' => ['title' => '分机号id', 'description' => '分机号id', 'type' => 'integer', 'format' => 'int64', 'example' => '336450'], + 'IsDirect' => ['title' => '是否允许摘机外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许摘机外呼，0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Password' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'example' => 'Aa248236'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], + ], + ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增分机', + 'summary' => '通过此接口新增分机。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:04\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"9000\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"BindGatewayId\\": 28,\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 336450,\\n \\"IsDirect\\": 1,\\n \\"Password\\": \\"Aa248236\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateQueue' => [ + 'summary' => '用过此接口新增队列。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RouteType', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Queue', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '路由类型。取值：'."\n" - ."\n" - .'- **0**：归属地优先。'."\n" - .'- **1**：随机。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '队列信息', + 'description' => '队列信息', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['title' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'description' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + 'AnnounceSound' => ['title' => '播报固定语音 0关闭 1打开', 'description' => '播报固定语音 0关闭 1打开', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'WrapupTime' => ['title' => '整理时间，取值范围3-3600秒', 'description' => '整理时间，取值范围3-3600秒', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30'], + 'MaxLen' => ['title' => '最大等待数，设置范围0-999，0表示不做任何限制', 'description' => '最大等待数，设置范围0-999，0表示不做任何限制', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'Description' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'required' => true, 'example' => 'queueName'], + 'AnnouncePosition' => ['title' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'description' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'AnnounceSoundFile' => ['title' => '固定语音文件', 'description' => '固定语音文件', 'type' => 'string', 'required' => false, 'example' => 'announceSoundFile3'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], + 'QueueTimeout' => ['title' => '队列超时时间，取值范围20-600秒，默认600秒', 'description' => '队列超时时间，取值范围20-600秒，默认600秒', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '80'], + 'AnnounceSoundFrequency' => ['title' => '播放固定语音周期，秒数', 'description' => '播放固定语音周期，秒数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'AnnouncePositionYouarenext' => ['title' => '是否播报\'您是下一位\',0关闭，1开启', 'description' => '是否播报\'您是下一位\',0关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'AnnouncePositionParam' => ['title' => '多余少余n个时播报，必须大于等于2', 'description' => '多余少余n个时播报，必须大于等于2', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'MemberTimeout' => ['title' => '座席超时时间，取值范围20-60秒，默认25秒', 'description' => '座席超时时间，取值范围20-60秒，默认25秒', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25'], + 'Weight' => ['title' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'description' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8'], + 'JoinEmpty' => ['title' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'description' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'required' => true, 'example' => '3003'], + 'MusicClass' => ['title' => '等待语音class', 'description' => '等待语音class', 'type' => 'string', 'required' => true, 'example' => 'default'], + 'Strategy' => ['title' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'description' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'type' => 'string', 'required' => true, 'example' => 'rrordered'], + 'Retry' => ['title' => '座席超时无应答,呼叫下一座席的延迟秒数', 'description' => '座席超时无应答,呼叫下一座席的延迟秒数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5'], + 'SayAgentno' => ['title' => '语音报号，true:播报，false:不播报', 'description' => '语音报号，true:播报，false:不播报', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'VipSupport' => ['title' => '是否支持vip，1:支持，0:不支持', 'description' => '是否支持vip，1:支持，0:不支持', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + 'AnnouncePositionFrequency' => ['title' => '位置播报周期，秒数', 'description' => '位置播报周期，秒数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], 'required' => true, - 'docRequired' => true, - 'maximum' => '99999', - 'minimum' => '0', - 'example' => '0', + 'example' => '', ], ], [ - 'name' => 'PhoneNum', + 'name' => 'QueueSkills', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '服务实例ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)，在**服务实例管理**页面查看已申请的服务实例。', - 'type' => 'string', + 'title' => '队列技能', + 'description' => '队列技能', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '66'], + ], + 'required' => true, + 'description' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => '05516214****', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回200代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'successful', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '返回关联失败号码列表。'."\n" - ."\n" - .'> 如果全部关联成功，此参数不返回。', - 'type' => 'string', - 'example' => '1321111****', - ], - 'RequestId' => [ - 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'QueueSkills' => [ + 'title' => '队列所需技能数组', + 'description' => '队列技能数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'QueueId' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '51937'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'example' => '48734'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'integer', 'format' => 'int64', 'example' => '54474'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'Queue' => [ + 'title' => '队列配置信息', + 'description' => '队列配置信息', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['title' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'description' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'AnnounceSound' => ['title' => '播报固定语音 0关闭 1打开', 'description' => '播报固定语音 0关闭 1打开', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WrapupTime' => ['title' => '整理时间，取值范围3-3600秒', 'description' => '整理时间，取值范围3-3600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'MaxLen' => ['title' => '最大等待数，设置范围0-999，0表示不做任何限制', 'description' => '最大等待数，设置范围0-999，0表示不做任何限制', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Description' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => 'queueName'], + 'AnnouncePosition' => ['title' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'description' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnounceSoundFile' => ['title' => '固定语音文件', 'description' => '固定语音文件', 'type' => 'string', 'example' => 'sound_file3'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'QueueTimeout' => ['title' => '队列超时时间，取值范围5-600秒，默认600秒', 'description' => '队列超时时间，取值范围5-600秒，默认600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'AnnounceSoundFrequency' => ['title' => '播放固定语音周期，秒数', 'description' => '播放固定语音周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionYouarenext' => ['title' => '是否播报\'您是下一位\',0关闭，1开启', 'description' => '是否播报\'您是下一位\',0关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionParam' => ['title' => '多余少余n个时播报，必须大于等于2', 'description' => '多余少余n个时播报', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'MemberTimeout' => ['title' => '座席超时时间，取值范围20-60秒，默认25秒', 'description' => '座席超时时间，取值范围20-60秒，默认25秒', 'type' => 'integer', 'format' => 'int64', 'example' => '25'], + 'Weight' => ['title' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'description' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'JoinEmpty' => ['title' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'description' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'example' => '12331'], + 'MusicClass' => ['title' => '等待语音class', 'description' => '等待语音class', 'type' => 'string', 'example' => 'default'], + 'Strategy' => ['title' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'description' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'type' => 'string', 'example' => 'rrordered'], + 'Id' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], + 'Retry' => ['title' => '座席超时无应答,呼叫下一座席的延迟秒数', 'description' => '座席超时无应答,呼叫下一座席的延迟秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SayAgentno' => ['title' => '语音报号，true:播报，false:不播报', 'description' => '语音报号，true:播报，false:不播报', 'type' => 'boolean', 'example' => 'false'], + 'VipSupport' => ['title' => '是否支持vip，1:支持，0:不支持', 'description' => '是否支持vip，1:支持，0:不支持', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionFrequency' => ['title' => '位置播报周期，秒数', 'description' => '位置播报周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'UnauthorizedOperation', - 'errorMessage' => 'You have not been authorized.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增队列', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"QueueSkills\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48734,\\n \\"Id\\": 54474,\\n \\"EnterpriseId\\": 7000002\\n }\\n ],\\n \\"Queue\\": {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"sound_file3\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueTimeout\\": 60,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 2,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"12331\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 80,\\n \\"Retry\\": 5,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 10\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateQueueSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], - 500 => [ - [ - 'errorCode' => 'VirtualNumber.Query.Fail', - 'errorMessage' => 'Query virtual number fail.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to backend service exception.', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'required' => true, 'example' => '1000'], + ], + [ + 'name' => 'SkillId', + 'in' => 'query', + 'schema' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17'], + ], + [ + 'name' => 'SkillLevel', + 'in' => 'query', + 'schema' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9927CD06-C33A-50CC-A9BB-A3427967A66F'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-03-30 06:12:34'], + 'QueueId' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '51937'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'example' => '48735'], + 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'integer', 'format' => 'int64', 'example' => '54475'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '队列新增技能', + 'summary' => '队列增加技能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"1321111****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<AddVirtualNumberRelationResponse>\\n<RequestId>B0411112-6CF8-4752-81D1-918A1354AE49</RequestId>\\n<Message>successful</Message>\\n<Data>1321111*****</Data>\\n<Code>200</Code>\\n</AddVirtualNumberRelationResponse>","errorExample":""}]', - 'title' => '批量添加服务实例与真实号码绑定关系', - 'summary' => '批量添加服务实例与真实号码绑定关系。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：200次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9927CD06-C33A-50CC-A9BB-A3427967A66F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Qno\\": 1000,\\n \\"SkillLevel\\": 10,\\n \\"CreateTime\\": \\"2026-03-30 06:12:34\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48735,\\n \\"Id\\": 54475,\\n \\"EnterpriseId\\": 7122600\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVirtualNumberRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudCreateSkill' => [ + 'summary' => '通过此接口新增一个技能。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '产品名称。默认取值：**dyvms**。', - 'type' => 'string', - 'required' => false, - 'example' => 'dyvms', - 'default' => 'dyvms', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'PageNo', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。默认取值为1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '技能名称', 'description' => '技能名称', 'type' => 'string', 'required' => true, 'example' => 'skillName'], ], [ - 'name' => 'PageSize', + 'name' => 'Comment', 'in' => 'query', + 'schema' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'Comment3'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '每页显示的条数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '20', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'Comment3'], + 'CreateTime' => ['title' => '创建时间,精确到秒', 'description' => '创建时间,精确到秒', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Id' => ['title' => '技能id', 'description' => '技能id', 'type' => 'integer', 'format' => 'int64', 'example' => '49'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Name' => ['title' => '技能名称', 'description' => '技能名称', 'type' => 'string', 'example' => 'skillName'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增技能', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Comment\\": \\"Comment3\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 49,\\n \\"EnterpriseId\\": 7000002,\\n \\"Name\\": \\"skillName\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudCreateTask' => [ + 'summary' => '此接口用于新增外呼任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'RouteType', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '路由类型。取值：'."\n" - ."\n" - .'- **0**：归属地优先。'."\n" - ."\n" - .'- **1**：随机。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心id。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36'], ], [ - 'name' => 'QualificationId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '资质ID。此参数可不填。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000000542****', - ], + 'schema' => ['title' => '任务名称；需进行UTF-8格式的URLEncode编码，长度小于50字', 'description' => '任务名称；需进行UTF-8格式的URLEncode编码，长度小于50字', 'type' => 'string', 'required' => true, 'example' => 'taskName'], ], [ - 'name' => 'RegionNameCity', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '真实号码归属地。'."\n" - ."\n" - .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)**真实号管理**页面，查询号码归属地。', - 'type' => 'string', - 'required' => false, - 'example' => '浙江/杭州', - ], + 'schema' => ['title' => '任务描述；需进行UTF-8格式的URLEncode编码，长度小于200字', 'description' => '任务描述；需进行UTF-8格式的URLEncode编码，长度小于200字', 'type' => 'string', 'required' => false, 'example' => 'Task Description'], ], [ - 'name' => 'SpecId', + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '1.预测外呼任务 2.自动外呼任务。外呼任务创建后任务类型不支持修改', 'description' => '外呼任务创建后任务类型不支持修改。'."\n" + .'- 1：预测外呼任务。'."\n" + .'- 2：自动外呼任务。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['title' => '任务模板名称；通过任务模板可以实现对任务参数的统一管理以及简化接口传参，多个任务可以使用同一个模板管理参数，接口只需要传入任务间有差异的参数。参数生效规则：接口传入的参数优先。示例说明：如果接口传了参数autoStart=1和参数templateName=testTemplate，接口传入的参数autoStart生效。如果接口未传入autoStart参数或者传入的autoStart参数是空值，那么模版中的参数生效。注：任务模板可通过任务模板接口进行管理', 'description' => '任务模板名称。'."\n" + .'1. 通过任务模板可以实现对任务参数的统一管理以及简化接口传参，多个任务可以使用同一个模板管理参数，接口只需要传入任务间有差异的参数。'."\n" + .'2. 参数生效规则：接口传入的参数优先。'."\n" + .'3. 示例说明：如果接口传了参数autoStart=1和参数templateName=testTemplate，接口传入的参数autoStart生效。如果接口未传入autoStart参数或者传入的autoStart参数是空值，那么模版中的参数生效。'."\n" + ."\n" + .'> - 任务模板可通过任务模板接口进行管理。', 'type' => 'string', 'required' => false, 'example' => 'TemplateName'], + ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['title' => '定时开始；0.关闭 1.开启，默认关闭。值为1时autoStartDay和autoStartTime参数才生效，并且至少设置其中的一个', 'description' => '定时开始，默认关闭。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启'."\n" + ."\n" + .'> - 值为1时autoStartDay和autoStartTime参数才生效，并且至少设置其中的一个。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoStartDay', + 'in' => 'query', + 'schema' => ['title' => '定时开始日期；autoStart=1时生效。参数不传入时默认在当天的autoStartTime定时启动。格式：yyyy-MM-dd，如：2017-01-01', 'description' => '定时开始日期；autoStart=1时生效。参数不传入时默认在当天的autoStartTime定时启动。格式：yyyy-MM-dd，如：2017-01-01', 'type' => 'string', 'required' => false, 'example' => '2026-01-01'], + ], + [ + 'name' => 'AutoStartTime', + 'in' => 'query', + 'schema' => ['title' => '定时开始时间；autoStart=1时生效。参数不传入时默认在autoStartDay的00:00:00定时启动。格式：HH:mm:ss，如：08:00:00', 'description' => '定时开始时间；autoStart=1时生效。参数不传入时默认在autoStartDay的00:00:00定时启动。格式：HH:mm:ss，如：08:00:00', 'type' => 'string', 'required' => false, 'example' => '08:00:00'], + ], + [ + 'name' => 'AutoStop', + 'in' => 'query', + 'schema' => ['title' => '定时完成；0.关闭 1.开启，默认关闭。值为1时autoStopDay和autoStopTime参数才生效，并且至少设置其中的一个', 'description' => '定时完成，默认关闭。'."\n" + .'- 0：关闭；'."\n" + .'- 1：开启'."\n" + ."\n" + .'> - 值为1时autoStopDay和autoStopTime参数才生效，并且至少设置其中的一个。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoStopDay', + 'in' => 'query', + 'schema' => ['title' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2017-01-01', 'description' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2017-01-01', 'type' => 'string', 'required' => false, 'example' => '2026-01-01'], + ], + [ + 'name' => 'AutoStopTime', + 'in' => 'query', + 'schema' => ['title' => '定时完成时间；autoStop=1时生效。参数不传入时默认在autoStopDay的23:59:59定时完成。格式：HH:mm:ss，如：17:00:00', 'description' => '定时完成时间；autoStop=1时生效。参数不传入时默认在autoStopDay的23:59:59定时完成。格式：HH:mm:ss，如：17:00:00', 'type' => 'string', 'required' => false, 'example' => '17:00:00'], + ], + [ + 'name' => 'ForceEndFlag', + 'in' => 'query', + 'schema' => ['title' => '定时完成时强制结束任务；autoStop=1时生效。0.关闭 1.开启，默认关闭。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'description' => '定时完成时强制结束任务；autoStop=1时生效。0.关闭 1.开启，默认关闭。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoTaskType', + 'in' => 'query', + 'schema' => ['title' => '0.连续呼叫 1.间隔呼叫，默认连续呼叫。配合定时开始（autoStart）和定时结束（autoStop）参数使用，如任务需要在每天的特定时间段内呼叫则开启间隔呼叫方式', 'description' => '配合定时开始（autoStart）和定时结束（autoStop）参数使用，如任务需要在每天的特定时间段内呼叫则开启间隔呼叫方式。默认连续呼叫。'."\n" + .'- 0：连续呼叫'."\n" + .'- 1：间隔呼叫', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoTriggerTimeStrategy', + 'in' => 'query', + 'schema' => ['title' => '间隔呼叫时间段；autoTaskType=1时必填。呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'description' => '间隔呼叫时间段；autoTaskType=1时必填。呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：`9,22`。'."\n" + ."\n" + .'> - 时间条件列表可通过查询时间条件设置列表接口获取。', 'type' => 'string', 'required' => false, 'example' => '9,22'], + ], + [ + 'name' => 'AutoComplete', + 'in' => 'query', + 'schema' => ['title' => '0.关闭 1.开启，默认开启。开启：任务中的号码呼叫完后，任务自动完成，状态设置为结束，关闭：任务中的号码呼叫完后，任务自动暂停，状态设置为暂停注：任务在结束状态时无法再次启动。', 'description' => '默认开启。'."\n" + .'- 1：开启；任务中的号码呼叫完后，任务自动完成，状态设置为结束。'."\n" + .'- 0：关闭；任务中的号码呼叫完后，任务自动暂停，状态设置为暂停。'."\n" + ."\n" + .'> - 任务在结束状态时无法再次启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'RetryStrategy', + 'in' => 'query', + 'schema' => ['title' => '重试策略；「基础模式」数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟「高级模式」高级模式需要开启「号码状态识别」服务数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致 注：基础模式和高级模式的区分根据传入的参数格式自动识别。基于首次呼叫时间重试时，每轮的重试时间必须大于上一轮的时间', 'description' => '重试策略；'."\n" + .'1. 【基础模式】： '."\n" + ."\n" + .' - 数据结构为Json格式：```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```'."\n" + .' - 格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟。'."\n" + ."\n" + .'2. 【高级模式】：'."\n" + .' - 高级模式需要开启「号码状态识别」服务数据结构JsonArray格式 ：```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```'."\n" + .' - 格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致。'."\n" + ."\n" + .'> - 基础模式和高级模式的区分根据传入的参数格式自动识别。基于首次呼叫时间重试时，每轮的重试时间必须大于上一轮的时间。', 'type' => 'string', 'required' => false, 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}'], + ], + [ + 'name' => 'RetryStrategyTimeType', + 'in' => 'query', + 'schema' => ['title' => '重试策略时间类型；配置重试策略时生效。 1.基于首次呼叫时间 2.基于上次呼叫时间，默认基于首次呼叫时间', 'description' => '重试策略时间类型；配置重试策略时生效。 '."\n" + .'- 1：基于首次呼叫时间'."\n" + .'- 2：基于上次呼叫时间，默认基于首次呼叫时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RetryStrategyOnlyToday', + 'in' => 'query', + 'schema' => ['title' => '任务仅当天生效；0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据，默认关闭', 'description' => '任务仅当天生效；'."\n" + .'- 0：关闭'."\n" + .'- 1：开启，删除待重试的数据和待呼叫的数据'."\n" + .'- 2：开启，删除待重试的数据'."\n" + .'- 3：开启，删除待呼叫的数据，默认关闭', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CallPriorityStrategy', + 'in' => 'query', + 'schema' => ['title' => '数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```格式说明：sort是重试号码和未呼叫号码的呼叫顺序 type：retryCall重试号码、firstCall未呼叫号码当type=retryCall，desc：0.优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫 1.优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫当type=firstCall时，orderType：随机呼叫，0顺序(优先级) 1随机 2顺序(导入时间)', 'description' => '- 数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```'."\n" + .'- 格式说明：'."\n" + .' - sort：是重试号码和未呼叫号码的呼叫顺序；'."\n" + .' - type：retryCall重试号码、firstCall未呼叫号码当type=retryCall；'."\n" + .' - desc：'."\n" + .' - 0优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫；'."\n" + .' - 1优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫当type=firstCall时，orderType：随机呼叫，0顺序(优先级) ；1随机；2顺序(导入时间)。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CustomerClidsCategory', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码类型；1.外显固话 2.外显手机号 4.外显号码池 5.外显导航注：推荐使用外显导航，可以灵活调整和控制外显策略。其他类型将逐步下线', 'description' => '客户侧外显号码类型；'."\n" + .'- 1：外显固话'."\n" + .'- 2：外显手机号'."\n" + .'- 4：外显号码池'."\n" + .'- 5：外显导航'."\n" + ."\n" + .'> - 推荐使用外显导航，可以灵活调整和控制外显策略。其他类型将逐步下线。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CustomerClids', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码列表；customerClidsCategory=1或2时必填。支持多个，多个直接使用英文逗号\',\'分隔。不建议使用', 'description' => '客户侧外显号码列表；customerClidsCategory=1或2时必填。支持多个，多个直接使用英文逗号\',\'分隔。不建议使用', 'type' => 'string', 'required' => false, 'example' => '7744331,7744332'], + ], + [ + 'name' => 'CustomerClidType', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显规则；customerClidsCategory=1或2时生效。1.随机 2.按区号，默认随机。不建议使用', 'description' => '客户侧外显规则；customerClidsCategory=1或2时生效。默认随机。不建议使用'."\n" + .'- 1：随机'."\n" + .'- 2：按区号', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显规则；customerClidType=2时生效。Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}。不建议使用', 'description' => '外显规则；customerClidType=2时生效。Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}。不建议使用', 'type' => 'string', 'required' => false, 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}'], + ], + [ + 'name' => 'CustomerClidWeightFlag', + 'in' => 'query', + 'schema' => ['title' => '外显号码比例配置开关；customerClidsCategory=1时生效。0.关闭 1.开启，默认关闭。不建议使用', 'description' => '外显号码比例配置开关；customerClidsCategory=1时生效。默认关闭。不建议使用。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CustomerClidWeight', + 'in' => 'query', + 'schema' => ['title' => '外显号码比例配置内容；customerClidsCategory=1且customerClidWeightFlag=1时生效。JsonArray格式 [{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]，不建议使用', 'description' => '外显号码比例配置内容；customerClidsCategory=1且customerClidWeightFlag=1时生效。JsonArray格式 [{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]，不建议使用', 'type' => 'string', 'required' => false, 'example' => '[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]'], + ], + [ + 'name' => 'CustomerClidsGroup', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码池名称或外显导航标识；customerClidsCategory=4或5时必填。customerClidsCategory=4时customerClidsGroup传号码池名称。customerClidsCategory=5时customerClidsGroup传外显导航标识', 'description' => '客户侧外显号码池名称或外显导航标识；customerClidsCategory=4或5时必填。customerClidsCategory=4时customerClidsGroup传号码池名称。customerClidsCategory=5时customerClidsGroup传外显导航标识', 'type' => 'string', 'required' => false, 'example' => 'example'], + ], + [ + 'name' => 'CustomerTimeout', + 'in' => 'query', + 'schema' => ['title' => '客户超时时间；单位秒数，默认30秒，取值范围5 ~ 60', 'description' => '客户超时时间；单位秒数，默认30秒，取值范围5 ~ 60', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'CallRouteStrategy', + 'in' => 'query', + 'schema' => ['title' => '1.直连座席 2.AI转人工 直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验 AI转人工：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本', 'description' => '- 1：直连座席。直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验。'."\n" + .'- 2：AI转人工。AI转人工模式：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['title' => '语音导航Id；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。预测外呼使用场景：如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效自动外呼使用场景：客户接听后，转到的语音导航', 'description' => '语音导航Id；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。预测外呼使用场景：如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效自动外呼使用场景：客户接听后，转到的语音导航', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '42'], + ], + [ + 'name' => 'IvrName', + 'in' => 'query', + 'schema' => ['title' => '语音导航名称；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。', 'description' => '语音导航名称；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。', 'type' => 'string', 'required' => false, 'example' => 'IvrName1'], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => ['title' => '任务维度限制最大并发数，实际并发不会超过最大并发限制。type=1时，配置成0表示不限制，座席数量少于10时建议配置该参数', 'description' => '任务维度限制最大并发数，实际并发不会超过最大并发限制。type=1时，配置成0表示不限制，座席数量少于10时建议配置该参数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'UserFields', + 'in' => 'query', + 'schema' => ['title' => '任务自定义字段。JsonArray格式；数组的每个元素只支持传递一组键值对，传递多组只取第一组，如 {"key", "value"}。 默认空值，示例：[{"name":"1234"},{"name1":"12345"}] 注：单个字段值的长度不能超过1000个字符', 'description' => '任务自定义字段。JsonArray格式；数组的每个元素只支持传递一组键值对，传递多组只取第一组，如 {"key", "value"}。 默认空值，示例：[{"name":"1234"},{"name1":"12345"}] 注：单个字段值的长度不能超过1000个字符', 'type' => 'string', 'required' => false, 'example' => '[{"name":"1234"},{"name1":"12345"}]'], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['title' => '座席通道变量。JsonArray格式；最大支持5个变量。默认空值， 示例：[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] 注：单个字段值的长度不能超过1000个字符。变量会以SIP_HEADER的形式设置到座席侧通道', 'description' => '座席通道变量。JsonArray格式；最大支持5个变量。默认空值， 示例：[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] 注：单个字段值的长度不能超过1000个字符。变量会以SIP_HEADER的形式设置到座席侧通道', 'type' => 'string', 'required' => false, 'example' => '[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] '], + ], + [ + 'name' => 'TimeStrategy', + 'in' => 'query', + 'schema' => ['title' => '禁呼时间；在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'description' => '禁呼时间；在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'type' => 'string', 'required' => false, 'example' => '9,22'], + ], + [ + 'name' => 'AutoDelete', + 'in' => 'query', + 'schema' => ['title' => '0.关闭 1.自动删除。任务数超出最大任务数限制时，是否自动删除已完成的最早创建的任务，值为1代表自动删除。注：autoDelete不是任务属性，只在接口调用时生效', 'description' => '任务数超出最大任务数限制时，是否自动删除已完成的最早创建的任务，值为1代表自动删除。注：autoDelete不是任务属性，只在接口调用时生效'."\n" + .'- 0：关闭'."\n" + .'- 1：自动删除', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CallGroupType', + 'in' => 'query', + 'schema' => ['title' => '指定座席方式；1.座席工号列表 2.外呼组，默认座席工号列表注：任务创建后不支持修改', 'description' => '指定座席方式；'."\n" + .'- 1：座席工号列表'."\n" + .'- 2：外呼组，默认座席工号列表'."\n" + ."\n" + .'> - 任务创建后不支持修改。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席工号列表；callGroupType=1时必填。支持多个座席工号，多个之间使用英文逗号\',\'分隔注：一个座席只能在一个运行中的任务中', 'description' => '座席工号列表；callGroupType=1时必填。支持多个座席工号，多个之间使用英文逗号\',\'分隔注：一个座席只能在一个运行中的任务中', 'type' => 'string', 'required' => false, 'example' => '1111,2222'], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => ['title' => '外呼组号；callGroupType=2时必填。注：一个外呼组可以绑定到多个任务，但只能同时运行一个任务中', 'description' => '外呼组号；callGroupType=2时必填。注：一个外呼组可以绑定到多个任务，但只能同时运行一个任务中', 'type' => 'string', 'required' => false, 'example' => '33'], + ], + [ + 'name' => 'CallStrategy', + 'in' => 'query', + 'schema' => ['title' => '座席分配规则；1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长），默认随机', 'description' => '座席分配规则；默认随机。'."\n" + .'- 1：随机'."\n" + .'- 2：顺序'."\n" + .'- 3.座席未进线最大时（从上一次呼叫结束到当前的总时长）'."\n" + .'- 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长）', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AgentTimeout', + 'in' => 'query', + 'schema' => ['title' => '座席超时时间；单位秒数，默认10秒，取值范围5 ~ 60', 'description' => '座席超时时间；单位秒数，默认10秒，取值范围5 ~ 60', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '52'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '座席整理时间；默认30秒，取值范围1～10800，整理时间会影响每次呼叫的个数，值越大，呼叫号码个数会减小', 'description' => '座席整理时间；默认30秒，取值范围1～10800，整理时间会影响每次呼叫的个数，值越大，呼叫号码个数会减小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'MaxWaitTime', + 'in' => 'query', + 'schema' => ['title' => '座席最长等待时间；默认40秒，最小10，最大600，允许座席空闲的最大时间。任务执行过程中，如果座席平均空闲时间大于maxWaitTime，每次呼叫个数会增加', 'description' => '座席最长等待时间；默认40秒，最小10，最大600，允许座席空闲的最大时间。任务执行过程中，如果座席平均空闲时间大于maxWaitTime，每次呼叫个数会增加', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40'], + ], + [ + 'name' => 'MinAvailableAgentCount', + 'in' => 'query', + 'schema' => ['title' => '最小可用座席数；默认为10，取值范围1 ~ 10。任务内可用座席数小于当前值时，任务自动暂停，避免骚扰', 'description' => '最小可用座席数；默认为10，取值范围1 ~ 10。任务内可用座席数小于当前值时，任务自动暂停，避免骚扰', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Quotiety', + 'in' => 'query', + 'schema' => ['title' => '骚扰率；默认值为1，取值范围为大于0，小于等于20，支持小数，精确到小数点两位。值越小呼叫的号码越少，值越大呼叫的号码越多，座席利用率越高', 'description' => '骚扰率；默认值为1，取值范围为大于0，小于等于20，支持小数，精确到小数点两位。值越小呼叫的号码越少，值越大呼叫的号码越多，座席利用率越高', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '17.62'], + ], + [ + 'name' => 'PredictAdjust', + 'in' => 'query', + 'schema' => ['title' => '超呼率；默认值为100，取值范围50～400', 'description' => '超呼率；默认值为100，取值范围50～400', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55'], + ], + [ + 'name' => 'CallLimitStrategy', 'in' => 'query', + 'schema' => ['title' => '座席当日接听的通话个数上限，使用方式详见下方说明；JsonArray格式 [{"cnos":["2000","2001"],"limit":"5"}注：使用座席当日接听数限制功能需开启企业配置，功能开启并且配置上限后系统才开始统计当日接听数', 'description' => '座席当日接听的通话个数上限，使用方式详见下方说明；JsonArray格式 [{"cnos":["2000","2001"],"limit":"5"}注：使用座席当日接听数限制功能需开启企业配置，功能开启并且配置上限后系统才开始统计当日接听数', 'type' => 'string', 'required' => false, 'example' => ' [{"cnos":["2000","2001"],"limit":"5"}]'], + ], + [ + 'name' => 'CustomerMoh', + 'in' => 'query', + 'schema' => ['title' => '客户侧等待音；客户接听后呼叫座席，等待座席接听时播放的语音，默认为空白音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'description' => '客户侧等待音；客户接听后呼叫座席，等待座席接听时播放的语音，默认为空白音。支持公共语音和企业语音，值为语音文件的path。', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819'], + ], + [ + 'name' => 'CustomerVoice', + 'in' => 'query', + 'schema' => ['title' => '客户侧提示音；客户接听后呼转座席前播放的语音，提示音播放完成后再找座席，默认无提示音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'description' => '客户侧提示音；客户接听后呼转座席前播放的语音，提示音播放完成后再找座席，默认无提示音。支持公共语音和企业语音，值为语音文件的path。', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819'], + ], + [ + 'name' => 'AnswerRate', + 'in' => 'query', + 'schema' => ['title' => '初始化预计客户接通率；默认50，取值范围1～100，预热阶段的呼叫，按照此接通率计算呼叫频率', 'description' => '初始化预计客户接通率；默认50，取值范围1～100，预热阶段的呼叫，按照此接通率计算呼叫频率', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '59'], + ], + [ + 'name' => 'WarmUpDuration', + 'in' => 'query', + 'schema' => ['title' => '任务预热时间；默认300秒, 取值范围60 ～ 600', 'description' => '任务预热时间；默认300秒, 取值范围60 ～ 600', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '93'], + ], + [ + 'name' => 'IsRewarm', + 'in' => 'query', + 'schema' => ['title' => '暂停后重新预热；0.关闭，1开启，默认开启，任务暂停后是否需要重新预热', 'description' => '暂停后重新预热；默认开启，任务暂停后是否需要重新预热。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '号码类型。取值：'."\n" - ."\n" - .'- **1**：虚商号码。'."\n" - .'- **2**：运营商号码。'."\n" - .'- **3**：95开头的号码。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], + 'Message' => ['description' => '返回结果的提示信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OverTime' => ['description' => '任务结束时间', 'type' => 'string', 'example' => 'example'], + 'CustomerTimeout' => ['description' => '客户超时时间', 'type' => 'string', 'example' => 'example'], + 'Description' => ['description' => '任务描述', 'type' => 'string', 'example' => 'example'], + 'AutoStopDay' => ['description' => '定时完成日期，格式：yyyy-MM-dd，如：2026-04-11', 'type' => 'string', 'example' => 'example'], + 'AgentTimeout' => ['description' => '座席超时时间，单位秒', 'type' => 'string', 'example' => 'example'], + 'EnterpriseId' => ['description' => '企业编号', 'type' => 'string', 'example' => 'example'], + 'Name' => ['description' => '任务名称', 'type' => 'string', 'example' => 'example'], + 'Cnos' => ['description' => '座席工号列表', 'type' => 'string', 'example' => 'example'], + 'Concurrency' => ['description' => '最大并发限制', 'type' => 'string', 'example' => 'example'], + 'CustomerClids' => ['description' => '客户侧外显号码列表', 'type' => 'string', 'example' => 'example'], + 'AutoComplete' => ['description' => '自动完成。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AutoStart' => ['description' => '定时开始。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'string', 'example' => '1'], + 'AnswerRate' => ['description' => '初始化预计客户接通率', 'type' => 'string', 'example' => 'example'], + 'Status' => ['description' => '任务状态。'."\n" + .'- 0：初始'."\n" + .'- 1：运行中'."\n" + .'- 2：暂停'."\n" + .'- 3：结束', 'type' => 'string', 'example' => '3'], + 'CustomerMoh' => ['description' => '客户侧等待音', 'type' => 'string', 'example' => 'example'], + 'AutoStartDay' => ['description' => '定时开始日期，格式：yyyy-MM-dd', 'type' => 'string', 'example' => '2016-04-11'], + 'UserFields' => ['description' => '任务自定义字段，JsonArray格式', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'PredictAdjust' => ['description' => '超呼率', 'type' => 'string', 'example' => 'example'], + 'CreateTime' => ['description' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => 'example'], + 'StartTime' => ['description' => '任务开始时间', 'type' => 'string', 'example' => 'example'], + 'AutoStop' => ['description' => '定时完成。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'string', 'example' => '1'], + 'Wrapup' => ['description' => '座席整理时间，单位秒', 'type' => 'string', 'example' => '10'], + 'MaxWaitTime' => ['description' => '座席最大等待时间，单位秒', 'type' => 'string', 'example' => '10'], + 'Type' => ['description' => '任务类型。'."\n" + .'- 1：预测外呼任务'."\n" + .'- 2：自动外呼任务', 'type' => 'string', 'example' => '1'], + 'AutoStartTime' => ['description' => '定时开始时间，格式：HH:mm:ss', 'type' => 'string', 'example' => '08:00:00'], + 'IsRandom' => ['description' => '随机呼叫。'."\n" + .'- 0：关闭'."\n" + .'- 1：开启', 'type' => 'string', 'example' => '0'], + 'AutoStopTime' => ['description' => '定时完成时间，格式：HH:mm:ss', 'type' => 'string', 'example' => '17:00:00 '], + 'Id' => ['description' => '外呼任务Id', 'type' => 'string', 'example' => '11'], + 'IvrId' => ['description' => '语音导航Id', 'type' => 'string', 'example' => '330'], + 'Quotiety' => ['description' => '骚扰率，支持小数，精确到小数点两位', 'type' => 'string', 'example' => '0.33'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '新增呼叫任务', + 'description' => '接口支持创建预测外呼和自动外呼任务，任务类型通过type字段区分。'."\n" + .'创建任务数量如果超过最大任务限制，接口提供参数自动删除最早已完成的任务。'."\n" + ."\n" + .'为确保平台服务稳定性，本API设定以下使用限制：'."\n" + .'可创建任务数：≤ 100 个。'."\n" + .'可导入号码数：≤ 1000 万个。'."\n" + ."\n" + .'当触发上述任一限制时，本次请求失败。'."\n" + ."\n" + .'新增任务接口提供参数自动删除最早已完成的任务：'."\n" + .'- autoDelete：创建任务超出最大任务数限制时，是否自动删除已完成的最早创建的任务，值为1代表自动删除。'."\n" + .'- 平台提供删除任务接口「删除任务」：业务平台可根据实际情况定期自动删除已完成的任务。'."\n" + ."\n" + .'> - 删除任务时任务内的号码清单会全量删除，平台已呼叫过的通话记录明细、录音文件会继续保留。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OverTime\\": \\"example\\",\\n \\"CustomerTimeout\\": \\"example\\",\\n \\"Description\\": \\"example\\",\\n \\"AutoStopDay\\": \\"example\\",\\n \\"AgentTimeout\\": \\"example\\",\\n \\"EnterpriseId\\": \\"example\\",\\n \\"Name\\": \\"example\\",\\n \\"Cnos\\": \\"example\\",\\n \\"Concurrency\\": \\"example\\",\\n \\"CustomerClids\\": \\"example\\",\\n \\"AutoComplete\\": 1,\\n \\"AutoStart\\": \\"1\\",\\n \\"AnswerRate\\": \\"example\\",\\n \\"Status\\": \\"3\\",\\n \\"CustomerMoh\\": \\"example\\",\\n \\"AutoStartDay\\": \\"2016-04-11\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"PredictAdjust\\": \\"example\\",\\n \\"CreateTime\\": \\"example\\",\\n \\"StartTime\\": \\"example\\",\\n \\"AutoStop\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"Type\\": \\"1\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00 \\",\\n \\"Id\\": \\"11\\",\\n \\"IvrId\\": \\"330\\",\\n \\"Quotiety\\": \\"0.33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RelatedNum', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', 'in' => 'query', + 'schema' => ['title' => '座席工号；取值3-10位整数', 'description' => '座席工号；取值3-10位整数', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '真实号码。'."\n" - ."\n" - .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)**真实号管理**页面，获取真实号。', - 'type' => 'string', - 'required' => false, - 'example' => '0213144****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '错误提示信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他状态码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除座席', + 'summary' => '根据座席工号删除座席。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PhoneNum', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Gno', 'in' => 'query', + 'schema' => ['title' => '外呼组编号；说明：删除此gno对应的外呼组信息', 'description' => '外呼组编号；说明：删除此gno对应的外呼组信息', 'type' => 'string', 'required' => false, 'example' => 'WH123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '虚拟号码。'."\n" - ."\n" - .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)**服务实例管理**页面，获取服务实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => '05710000****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '9927CD06-C33A-50CC-A9BB-A3427967A66F'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，其它-失败', 'description' => '0-成功，其它-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除外呼组', + 'summary' => '通过本接口，可以进行删除外呼组操作。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9927CD06-C33A-50CC-A9BB-A3427967A66F\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteAgentTel' => [ + 'summary' => '删除座席下的电话。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号；3-10位数字', 'description' => '座席工号；3-10位数字', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['title' => '座席绑定电话；固话带区号，手机不加0；固话带分机的以\'-\'分隔', 'description' => '座席绑定电话；固话带区号，手机不加0；固话带分机的以\'-\'分隔', 'type' => 'string', 'required' => true, 'example' => '22223333'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回200代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => '200', - ], + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '服务实例和真实号绑定后的关系列表。部分字段含义：'."\n" - ."\n" - .'- **relatedNum**：真实号码。'."\n" - .'- **virtualNum**：服务实例ID。'."\n" - .'- **createTime**：号码开通时间。'."\n" - .'- **specName**：供应商名称。'."\n" - .'- **pageNo**：当前页码。'."\n" - .'- **pagSize**：每页显示的条数。'."\n" - .'- **total**：总数。'."\n" - .'- **regionNameProvince**：号码归属省。'."\n" - .'- **regionNameCity**：号码归属城市。'."\n" - .'- **corpName**：企业名称。', - 'type' => 'string', - 'example' => '{'."\n" - .' "data": ['."\n" - .' {'."\n" - .' "regionNameProvince": "湖南",'."\n" - .' "relatedNum": "0734284****",'."\n" - .' "specName": "联通全国",'."\n" - .' "createTime": "2021-07-02 16:04:49",'."\n" - .' "regionNameCity": "衡阳",'."\n" - .' "corpName": "阿里巴巴通信技术（北京）有限公司",'."\n" - .' "virtualNum": "05710000****"'."\n" - .' }'."\n" - .' ],'."\n" - .' "pageSize": 20,'."\n" - .' "total": 1,'."\n" - .' "pageNo": 1'."\n" - .'}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '8FAD5988-B483-48A4-B251-6E8470A67371', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => '返回结果。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'VirtualNumber.NotOwn', - 'errorMessage' => 'You can only use your own virtual number.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除座席电话', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteEnterpriseTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '时间条件id；id和name二选一，不可同时为空。', 'description' => '时间条件id；id和name二选一，不可同时为空。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '时间条件名称；id和name二选一，不可同时为空。', 'description' => '时间条件名称；id和name二选一，不可同时为空。', 'type' => 'string', 'required' => false, 'example' => 'name3'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FA46FC5-24CB-53BE-94F6-30CD8D66751C'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"regionNameProvince\\\\\\": \\\\\\"湖南\\\\\\",\\\\n \\\\\\"relatedNum\\\\\\": \\\\\\"0734284****\\\\\\",\\\\n \\\\\\"specName\\\\\\": \\\\\\"联通全国\\\\\\",\\\\n \\\\\\"createTime\\\\\\": \\\\\\"2021-07-02 16:04:49\\\\\\",\\\\n \\\\\\"regionNameCity\\\\\\": \\\\\\"衡阳\\\\\\",\\\\n \\\\\\"corpName\\\\\\": \\\\\\"阿里巴巴通信技术（北京）有限公司\\\\\\",\\\\n \\\\\\"virtualNum\\\\\\": \\\\\\"05710000****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"pageNo\\\\\\": 1\\\\n}\\",\\n \\"RequestId\\": \\"8FAD5988-B483-48A4-B251-6E8470A67371\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryVirtualNumberRelationResponse>\\n<RequestId>8FAD5988-B483-48A4-B251-6E8470A67371</RequestId>\\n<Data>\\n <data>\\n <relatedNum>1705559****</relatedNum>\\n <createTime>2021-03-26 12:34:08</createTime>\\n </data>\\n <pageSize>20</pageSize>\\n <total>1</total>\\n <pageNo>1</pageNo>\\n</Data>\\n<Code>200</Code>\\n</QueryVirtualNumberRelationResponse>","errorExample":""}]', - 'title' => '查询服务实例与真实号码绑定关系列表', - 'summary' => '查询服务实例与真实号码绑定后的数据列表，包括绑定真实号的时间，号码创建时间，某个服务实例下绑定真实号的数量等。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：200次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除时间条件设置', + 'summary' => '删除时间条件设置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"8FA46FC5-24CB-53BE-94F6-30CD8D66751C\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'ListServiceInstanceForPage' => [ - 'summary' => '分页查询服务实例列表', - 'methods' => [ - 'post', - 'get', + 'CloudDeleteExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['title' => '分机号,3-11位', 'description' => '分机号,3-11位', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '9000'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除分机', + 'summary' => '根据分机号删除分机。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteQueue' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Code', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['title' => '队列编号', 'description' => '队列编号', 'type' => 'string', 'required' => true, 'example' => '1112'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '服务实例号', - 'description' => '服务实例号', - 'type' => 'string', - 'required' => false, - 'example' => '0571****1234', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，其它-失败', 'description' => '0-成功，其它-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除队列', + 'summary' => '删除队列。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteQueueSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SceneId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Qno', 'in' => 'query', + 'schema' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'required' => true, 'example' => '10000'], + ], + [ + 'name' => 'SkillId', + 'in' => 'query', + 'schema' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '76'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '场景ID', - 'description' => '场景ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，其它-失败', 'description' => '0-成功，其它-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '队列删除技能', + 'summary' => '队列删除技能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteSkill' => [ + 'summary' => '删除技能。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'UsageId', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => '技能id；正整数，id和name可选，但不能同时为空。同时都传时，以id为准', 'description' => '技能id；正整数，id和name可选，但不能同时为空。同时都传时，以id为准', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '54'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '技能名称；id和name可选，但不能同时为空。同时都传时，以id为准', 'description' => '技能名称；id和name可选，但不能同时为空。同时都传时，以id为准', 'type' => 'string', 'required' => false, 'example' => 'name3'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '用途ID', - 'description' => '用途ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，-1 失败', 'description' => '0-成功，-1 失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除技能', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteTask' => [ + 'summary' => '支持删除预测外呼和自动外呼任务，只有在初始或完成状态的任务才能删除；删除任务时任务的号码也会被删除。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'RelationNumber', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '50'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '关联实体号码', - 'description' => '关联实体号码', - 'type' => 'string', - 'required' => false, - 'example' => '131****1111', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除呼叫任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudDeleteTaskTel' => [ + 'summary' => '通过此接口删除呼叫任务的号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Pager', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '35'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '批次Id', 'description' => '批次Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['title' => '批次名称；按照名称删除会删除最近添加的批次', 'description' => '批次名称；按照名称删除，会删除最近添加的批次', 'type' => 'string', 'required' => false, 'example' => 'test_1'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '号码状态；0:未呼叫 1:已呼叫', 'description' => '号码状态；0:未呼叫 1:已呼叫', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Tels', + 'in' => 'query', + 'schema' => ['title' => '电话号码；支持多个，多个号码用英文逗号","分隔；任务在运行中，号码也会被删除，最多支持10W个号码；支持加密号码删除，加密号码传参时需URL Encode', 'description' => '电话号码；支持多个，多个号码用英文逗号","分隔；任务在运行中，号码也会被删除，最多支持10W个号码；支持加密号码删除，加密号码传参时需URL Encode', 'type' => 'string', 'required' => false, 'example' => '18360957135'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '', - 'description' => '分页信息。', 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'title' => '每页数量，默认10，最大100', - 'description' => '每页数量，默认10，最大100', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'PageIndex' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], - 'required' => false, - 'example' => '', + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '呼叫任务号码删除', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAgent' => [ + 'summary' => '获取某个座席的详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号；查询指定工号对应的座席信息', 'description' => '座席工号；查询指定工号对应的座席信息', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'title' => '请求唯一id', - 'description' => '请求唯一id', - 'type' => 'string', - 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE', - ], - 'Message' => [ - 'title' => '响应消息', - 'description' => '响应消息', - 'type' => 'string', - 'example' => '每页最大100条！', - ], - 'Model' => [ - 'title' => '', - 'description' => '返回结果。', + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => '总数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'TotalPage' => [ - 'title' => '总页数', - 'description' => '总页数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '76', - ], - 'PageSize' => [ - 'title' => '每页数量', - 'description' => '每页数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], - 'PageNo' => [ - 'title' => '当前页码', - 'description' => '当前页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], - 'Records' => [ - 'title' => '', - 'description' => '返回数据列表', + 'Agent' => [ + 'title' => '座席列表数组', + 'description' => '座席列表数组', 'type' => 'array', 'items' => [ - 'description' => '返回数据对象', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '绑定状态：绑定；未绑定', - 'description' => '绑定状态：绑定；未绑定', - 'type' => 'string', - 'example' => '绑定', - ], - 'SceneId' => [ - 'title' => '场景ID', - 'description' => '场景ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '29', - ], - 'GmtCreate' => [ - 'title' => '创建时间（时间戳）', - 'description' => '创建时间（时间戳）', - 'type' => 'string', - 'example' => '1759109856000', - ], - 'SceneName' => [ - 'title' => '场景名称', - 'description' => '场景名称', - 'type' => 'string', - 'example' => '系统通知', - ], - 'InstanceStatus' => [ - 'title' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', - 'description' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', - 'type' => 'string', - 'example' => 'init', - ], - 'RelationTotalCount' => [ - 'title' => '关联总数量', - 'description' => '关联总数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33', - ], - 'UsageId' => [ - 'title' => '用途ID', - 'description' => '用途ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '96', - ], - 'Code' => [ - 'title' => '服务实例号', - 'description' => '服务实例号', - 'type' => 'string', - 'example' => '0571****1234', - ], - 'RelationAvailableCount' => [ - 'title' => '关联可用数量', - 'description' => '关联可用数量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'AliUid' => [ - 'title' => 'aliUid', - 'description' => 'aliUid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11******123', - ], - 'Name' => [ - 'title' => '服务实例名称', - 'description' => '服务实例名称', - 'type' => 'string', - 'example' => '测试数据', - ], - 'UsageName' => [ - 'title' => '用途名称', - 'description' => '用途名称', - 'type' => 'string', - 'example' => '语音通知', + 'LoginTime' => ['title' => '坐席最后一次登陆的时间', 'description' => '坐席最后一次登录的时间', 'type' => 'string', 'example' => '1774821736'], + 'ObClid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '22223333'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'PermitObPreviewTime' => ['title' => '可外呼时间段用,号分割', 'description' => '可外呼时间段用,号分割', 'type' => 'string', 'example' => '08:00,20:00'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Name' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'example' => '李四'], + 'IsObRemember' => ['title' => '外呼主叫记忆 1：开启 0：关闭', 'description' => '外呼主叫记忆 1：开启 0：关闭', 'type' => 'string', 'example' => '1'], + 'WebrtcUrlType' => ['title' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'string', 'example' => '1'], + 'ObClidProperty' => ['title' => '外显规则属性，JSON格式', 'description' => '外显规则属性，JSON格式', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}'], + 'Property' => ['title' => '座席主动挂机配置Json Str 格式数据 unLink 是否允许主动挂断, 0:关, 1:开，prohibitDuration禁止时长', 'description' => '座席主动挂机配置Json Str 格式数据 unLink 是否允许主动挂断, 0:关, 1:开，prohibitDuration禁止时长', 'type' => 'string', 'example' => '0'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Status' => ['title' => '座席状态，0:离线，1：在线', 'description' => '座席状态，0:离线，1：在线', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AsrCallType' => ['title' => '允许语音识别的通话类型，1:呼入 4：预览外呼 9：主叫外呼 5：预测外呼 2：webcall', 'description' => '允许语音识别的通话类型，1:呼入 4：预览外呼 9：主叫外呼 5：预测外呼 2：webcall', 'type' => 'string', 'example' => '2'], + 'Comment' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => '备注'], + 'MrcpProperty' => ['title' => '座席axb外呼是否使用mrcp方式推送语音流配置JSON Str格式数据', 'description' => '座席axb外呼是否使用mrcp方式推送语音流配置JSON Str格式数据', 'type' => 'string', 'example' => '{}'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BindTelType' => ['title' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'description' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Wrapup' => ['title' => '整理时间，秒数，默认10秒', 'description' => '整理时间，秒数，默认10秒', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IsAsr' => ['title' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'QueueList' => [ + 'title' => '坐席所属队列', + 'description' => '坐席所属队列', + 'type' => 'array', + 'items' => ['description' => '可忽略', 'type' => 'string', 'example' => '[]'], + 'example' => '', ], + 'AgentType' => ['title' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'description' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Active' => ['title' => '是否启用，0：停用，1：启用，默认启用', 'description' => '是否启用，0：停用，1：启用，默认启用', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ObClidType' => ['title' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'description' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IsAxbCall' => ['title' => '是否允许axb外呼，默认1开启 0关闭', 'description' => '是否允许axb外呼，默认1开启 0关闭', 'type' => 'string', 'example' => '0'], + 'UpdateTime' => ['title' => '更新时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '更新时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'AreaCode' => ['title' => '区号格式', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'BindTel' => ['title' => '座席绑定电话', 'description' => '座席绑定电话', 'type' => 'string', 'example' => '22223333'], + 'Id' => ['title' => '座席id', 'description' => '座席id', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Power' => ['title' => '1：班长席，0：普通座席，默认普通座席', 'description' => '1：班长席，0：普通座席，默认普通座席', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], 'example' => '', ], ], - 'example' => '', - ], - 'Code' => [ - 'title' => '状态码，OK表示响应成功', - 'description' => '状态码，OK表示响应成功', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '是否成功', - 'description' => '是否成功', - 'type' => 'boolean', - 'example' => 'true', ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席详细信息获取', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"每页最大100条！\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 36,\\n \\"TotalPage\\": 76,\\n \\"PageSize\\": 59,\\n \\"PageNo\\": 47,\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"绑定\\",\\n \\"SceneId\\": 29,\\n \\"GmtCreate\\": \\"1759109856000\\",\\n \\"SceneName\\": \\"系统通知\\",\\n \\"InstanceStatus\\": \\"init\\",\\n \\"RelationTotalCount\\": 33,\\n \\"UsageId\\": 96,\\n \\"Code\\": \\"0571****1234\\",\\n \\"RelationAvailableCount\\": 30,\\n \\"AliUid\\": 0,\\n \\"Name\\": \\"测试数据\\",\\n \\"UsageName\\": \\"语音通知\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '分页查询服务实例列表', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": [\\n {\\n \\"LoginTime\\": \\"1774821736\\",\\n \\"ObClid\\": \\"22223333\\",\\n \\"Cno\\": \\"1111\\",\\n \\"PermitObPreviewTime\\": \\"08:00,20:00\\",\\n \\"EnterpriseId\\": 7000002,\\n \\"Name\\": \\"李四\\",\\n \\"IsObRemember\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"1\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1,\\\\\\"isRandom\\\\\\":1}\\",\\n \\"Property\\": \\"0\\",\\n \\"IsOb\\": 1,\\n \\"Status\\": 1,\\n \\"AsrCallType\\": \\"2\\",\\n \\"Comment\\": \\"备注\\",\\n \\"MrcpProperty\\": \\"{}\\",\\n \\"CallPower\\": 0,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": 1,\\n \\"BindTelType\\": 1,\\n \\"Wrapup\\": 20,\\n \\"ObRecord\\": 1,\\n \\"IsAsr\\": 1,\\n \\"QueueList\\": [\\n \\"[]\\"\\n ],\\n \\"AgentType\\": 1,\\n \\"Active\\": 1,\\n \\"ObClidType\\": 1,\\n \\"IsAxbCall\\": \\"0\\",\\n \\"UpdateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"BindTel\\": \\"22223333\\",\\n \\"Id\\": 123,\\n \\"Power\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryVoiceFileAuditInfo' => [ - 'summary' => '查询语音文件审核状态。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudGetAgentStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '120076', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'VoiceCodes', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '单个座席号', 'description' => '单个座席号', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '语音文件ID。'."\n" - ."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" - ."\n" - .'> 每次查询最多支持10个语音文件，以半角逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回结果的提示信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'State' => ['title' => '座席状态描述（结合了登录状态和设备状态），离线，空闲，置忙，整理，呼叫中，响铃，保持，通话', 'description' => '座席状态描述（结合了登录状态和设备状态），离线，空闲，置忙，整理，呼叫中，响铃，保持，通话', 'type' => 'string', 'example' => '空闲'], + 'LoginStatus' => ['title' => '座席登录状态 0：离线状态 1：在线状态 2：置忙状态 3：整理状态', 'description' => '座席登录状态 0：离线状态 1：在线状态 2：置忙状态 3：整理状态', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DeviceStatus' => ['title' => '座席设备状态，座席登录状态不是离线时返回 -1：错误的状态 0：空闲状态 1：锁定状态 2：邀请中状态 3：响铃状态 4：使用中状态', 'description' => '座席设备状态，座席登录状态不是离线时返回 -1：错误的状态 0：空闲状态 1：锁定状态 2：邀请中状态 3：响铃状态 4：使用中状态', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StateAction' => ['title' => '状态对应的动作，座席登录状态不是离线时返回', 'description' => '状态对应的动作，座席登录状态不是离线时返回', 'type' => 'string', 'example' => 'idle'], + 'MainUniqueId' => ['title' => '座席当前参与的通话唯一标识，座席设备状态为1/2/3/4时返回', 'description' => '座席当前参与的通话唯一标识，座席设备状态为1/2/3/4时返回', 'type' => 'string', 'example' => 'medias_1-162046xxxx.12'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席实时状态获取', + 'summary' => '获取座席实时状态信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"State\\": \\"空闲\\",\\n \\"LoginStatus\\": 1,\\n \\"DeviceStatus\\": 1,\\n \\"StateAction\\": \\"idle\\",\\n \\"MainUniqueId\\": \\"medias_1-162046xxxx.12\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAreaCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'BusinessType', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['title' => '11位手机号；只能查询手机号', 'description' => '11位手机号；只能查询手机号', 'type' => 'string', 'required' => true, 'example' => '17750247753'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '语音文件类型。取值：'."\n" - ."\n" - .'- **0**（默认值）：语音通知文件'."\n" - .'- **2**：通话放音文件', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - 'enum' => [], + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '44D40F36-32D9-555E-89A6-26D39C3044D2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AreaCode' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'Tel' => ['title' => '手机号', 'description' => '手机号', 'type' => 'string', 'example' => '183xxxx7093'], + 'City' => ['title' => '号码所属城市', 'description' => '号码所属城市', 'type' => 'string', 'example' => '唐山'], + 'Province' => ['title' => '号码所属省份', 'description' => '号码所属省份', 'type' => 'string', 'example' => '河北'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '号码归属地查询', + 'summary' => '号码归属地查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"44D40F36-32D9-555E-89A6-26D39C3044D2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AreaCode\\": \\"010\\",\\n \\"Tel\\": \\"183xxxx7093\\",\\n \\"City\\": \\"唐山\\",\\n \\"Province\\": \\"河北\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetAsr' => [ + 'summary' => '查询ASR任务结果，获取数据。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => ['title' => '通话类型；1:呼入,2:webcall,4:预览外呼,5:预测外呼,6:主叫外呼,9:内部呼叫', 'description' => '通话类型；1:呼入,2:webcall,4:预览外呼,5:预测外呼,6:主叫外呼,9:内部呼叫', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'MainUniqueId', + 'in' => 'query', + 'schema' => ['title' => '主通道的唯一标识', 'description' => '主通道的唯一标识', 'type' => 'string', 'required' => true, 'example' => 'sip-2-1490862368.123'], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['title' => '当all=true时按照beignTime的顺序返回两侧对话文本', 'description' => '当all=true时按照beignTime的顺序返回两侧对话文本', 'type' => 'string', 'required' => false, 'example' => 'true'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回参数。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'返回OK代表请求成功。'."\n" - .'其他状态码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '返回结果。', - 'type' => 'array', - 'items' => [ - 'description' => '返回结果详情。', - 'type' => 'object', - 'properties' => [ - 'VoiceCode' => [ - 'description' => '语音文件Code。', - 'type' => 'string', - 'example' => '8501d2eb-efbb-471f-xxx8-****.wav', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RecordFileCount' => ['title' => '转写文件个数', 'description' => '转写文件个数', 'type' => 'string', 'example' => '1'], + 'MonitorType' => ['title' => '转写类型 1：混音 2：分轨', 'description' => '转写类型 1：混音 2：分轨', 'type' => 'string', 'example' => '1'], + 'RecordFileText1In' => [ + 'title' => '第一侧转写文本结果', + 'description' => '第一侧转写文本结果', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'example'], + 'BizDuration' => ['description' => '语音转换时长。单位：ms', 'type' => 'integer', 'format' => 'int64', 'example' => '33340'], + 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => '8f2ff56a7cfe458c942595b2f271d715'], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '""'], + 'StatusCode' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int64', 'example' => 'SUCCEED'], + 'Result' => [ + 'title' => '转写结果', + 'description' => '转写结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '31805'], + 'SilenceDuration' => ['title' => '沉默时间', 'description' => '沉默时长，单位：s', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'BeginTime' => ['title' => '开始时间', 'description' => '开始时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '30140'], + 'Text' => ['title' => '转写文本', 'description' => '转写文本', 'type' => 'string', 'example' => '您好，很高兴为您服务'], + 'ChannelId' => ['title' => '通道id', 'description' => '通道id', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SpeechRate' => ['title' => '语速', 'description' => '语速（单位：字/分钟）', 'type' => 'integer', 'format' => 'int64', 'example' => '108'], + 'EmotionValue' => ['title' => '情感值', 'description' => '情感值', 'type' => 'number', 'format' => 'double', 'example' => '6.0'], + ], + 'description' => '', + ], + 'example' => '', + ], ], - 'AuditState' => [ - 'description' => '审核状态。取值：'."\n" - ."\n" - .'- **AUDIT_STATE_INIT**：审批中'."\n" - .'- **AUDIT_STATE_PASS**：审批通过'."\n" - .'- **AUDIT_STATE_NOT_PASS**：审批不通过'."\n" - .'- **AUDIT_STATE_UPLOADING**：审批已通过文件上传中'."\n" - .'- **AUDIT_STATE_REDOING**：重新处理中'."\n" - .'- **AUDIT_SATE_CANCEL**：取消审批'."\n" - .'- **AUDIT_PAUSE**：暂停审批'."\n" - .'- **AUDIT_ORDER_FINISHED**：工单系统审核完成，等待运营商审核', - 'type' => 'string', - 'example' => 'AUDIT_STATE_NOT_PASS', + 'example' => '', + ], + 'RecordFileText1Out' => [ + 'title' => '第二侧转写文本结果', + 'description' => '第二侧转写文本结果', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '状态', 'description' => '状态', 'type' => 'string', 'example' => 'SUCCEED'], + 'BizDuration' => ['description' => '语音转换时长。单位：ms', 'type' => 'integer', 'format' => 'int64', 'example' => '33340'], + 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => '145a13227e3249258cd3b5232a56d634'], + 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '""'], + 'StatusCode' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Result' => [ + 'title' => '转写结果', + 'description' => '转写结果', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '31515'], + 'SilenceDuration' => ['title' => '沉默时间', 'description' => '沉默时长，单位：s', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BeginTime' => ['title' => '开始时间', 'description' => '开始时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '30550'], + 'Text' => ['title' => '转写文本', 'description' => '转写文本', 'type' => 'string', 'example' => '你好，我想咨询一些问题'], + 'ChannelId' => ['title' => '通道id', 'description' => '通道id', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'SpeechRate' => ['title' => '语速', 'description' => '语速（单位：字/分钟）', 'type' => 'integer', 'format' => 'int64', 'example' => '186'], + 'EmotionValue' => ['title' => '情感值', 'description' => '情感值', 'type' => 'number', 'format' => 'double', 'example' => '6.0'], + ], + 'description' => '', + ], + 'example' => '', + ], ], - 'RejectInfo' => [ - 'description' => '审核信息。', - 'type' => 'string', - 'example' => '如电话沟通，该业务暂不支持', + 'example' => '', + ], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'string', 'example' => '7000002'], + 'Result' => [ + 'title' => '转写结果, 当all=true时返回', + 'description' => '转写结果, 当all=true时返回', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Side' => ['title' => '语音文本所属方；in: 第一侧；out: 第二侧', 'description' => '语音文本所属方；in: 第一侧；out: 第二侧', 'type' => 'string', 'example' => 'out'], + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '10445'], + 'SilenceDuration' => ['title' => '沉默时间', 'description' => '沉默时长，单位：s', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BeginTime' => ['title' => '开始时间', 'description' => '开始时间（距通话开始时的时间戳，单位：ms）', 'type' => 'integer', 'format' => 'int64', 'example' => '4350'], + 'Text' => ['title' => '转写文本', 'description' => '转写文本', 'type' => 'string', 'example' => 'example'], + 'ChannelId' => ['title' => '通道id', 'description' => '通道id', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'SpeechRate' => ['title' => '语速', 'description' => '语速（单位：字/分钟）', 'type' => 'integer', 'format' => 'int64', 'example' => '255'], + 'EmotionValue' => ['title' => '情感值', 'description' => '情感值', 'type' => 'number', 'format' => 'double', 'example' => '7.0'], + ], + 'description' => '', ], + 'example' => '', ], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - 'Message' => [ - 'description' => '状态码描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Query.Voice.File.Limit', - 'errorMessage' => 'Voice file query number cannot exceed 10', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ASR查询任务结果', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RecordFileCount\\": \\"1\\",\\n \\"MonitorType\\": \\"1\\",\\n \\"RecordFileText1In\\": {\\n \\"Status\\": \\"example\\",\\n \\"BizDuration\\": 33340,\\n \\"Id\\": \\"8f2ff56a7cfe458c942595b2f271d715\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StatusCode\\": 0,\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 31805,\\n \\"SilenceDuration\\": 1,\\n \\"BeginTime\\": 30140,\\n \\"Text\\": \\"您好，很高兴为您服务\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 108,\\n \\"EmotionValue\\": 6\\n }\\n ]\\n },\\n \\"RecordFileText1Out\\": {\\n \\"Status\\": \\"SUCCEED\\",\\n \\"BizDuration\\": 33340,\\n \\"Id\\": \\"145a13227e3249258cd3b5232a56d634\\",\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"StatusCode\\": 0,\\n \\"Result\\": [\\n {\\n \\"EndTime\\": 31515,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 30550,\\n \\"Text\\": \\"你好，我想咨询一些问题\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 186,\\n \\"EmotionValue\\": 6\\n }\\n ]\\n },\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Result\\": [\\n {\\n \\"Side\\": \\"out\\",\\n \\"EndTime\\": 10445,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 4350,\\n \\"Text\\": \\"example\\",\\n \\"ChannelId\\": 32,\\n \\"SpeechRate\\": 255,\\n \\"EmotionValue\\": 7\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetExten' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['title' => '分机号，3-11位', 'description' => '分机号，3-11位', 'type' => 'string', 'required' => true, 'example' => '9000'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"VoiceCode\\": \\"8501d2eb-efbb-471f-xxx8-****.wav\\",\\n \\"AuditState\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"RejectInfo\\": \\"如电话沟通，该业务暂不支持\\"\\n }\\n ],\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', - 'title' => '查询语音文件审核状态', - ], - 'QueryCallDetailByCallId' => [ - 'methods' => [ - 'post', - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'JitterBuffer' => ['title' => '网络防抖', 'description' => '网络防抖', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-03-30 06:09:04'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Exten' => ['title' => '分机号，3-11位', 'description' => '分机号，3-11位', 'type' => 'string', 'example' => '9000'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Allow' => ['title' => '语音编码', 'description' => '语音编码', 'type' => 'string', 'example' => 'alaw,ulaw'], + 'BindGatewayId' => ['title' => '绑定的agent-gateway', 'description' => '绑定的agent-gateway', 'type' => 'integer', 'format' => 'int64', 'example' => '22'], + 'Type' => ['title' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'description' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AreaCode' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'Denoise' => ['title' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'description' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Id' => ['title' => '分机号id', 'description' => '分机号id', 'type' => 'integer', 'format' => 'int64', 'example' => '336450'], + 'IsDirect' => ['title' => '是否允许摘机外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许摘机外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], + 'Password' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'example' => 'Aa248236'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询分机', + 'summary' => '查询指定分机信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"JitterBuffer\\": 0,\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:04\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"9000\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"BindGatewayId\\": 22,\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 336450,\\n \\"IsDirect\\": \\"1\\",\\n \\"Password\\": \\"Aa248236\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetObCdr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52694', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '通话的唯一识别ID。调用外呼接口发起通话后，返回参数中会携带CallId。'."\n" - .' - 获取的CallId与**QueryDate**必须是同一天。示例：CallId的时间是2022.11.21，**QueryDate**必须也是2022.11.21内的时间。'."\n" - .' - 获取的CallId与**ProdId**参数值必须匹配。示例：CallId是在发送语音通知后获取的，那**ProdId**参数需要填写语音通知产品ID即**11000000300006**。', - 'type' => 'string', - 'required' => true, - 'example' => '116014888060^10281631****', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'ProdId', + 'name' => 'UniqueId', 'in' => 'query', + 'schema' => ['title' => '电话唯一标识；对应座席外呼通话记录的uniqueId', 'description' => '电话唯一标识；对应座席外呼通话记录的uniqueId', 'type' => 'string', 'required' => true, 'example' => 'uniq_1-162046xxxx.12'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '产品ID。取值：'."\n" - .'- **11000000300006**：语音通知。'."\n" - .'- **11010000138001**：语音验证码。'."\n" - .'- **11000000300005**：语音IVR，向指定号码发起交互式语音通话。'."\n" - .'- **11000000300009**：语音SIP。'."\n" - .'- **11030000180001**：智能外呼。'."\n" - ."\n" - .'> 获取的CallId与**ProdId**参数值必须匹配，不匹配或传入错误的产品ID将无法返回**Data**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11000000300006', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '座席外呼通话记录详情', + 'description' => '座席外呼通话记录详情', + 'type' => 'array', + 'items' => [ + 'description' => '座席外呼通话记录详情', + 'type' => 'object', + 'properties' => [ + 'DisplayNumber' => ['title' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧真实外显号码为虚拟号', 'description' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧真实外显号码为虚拟号', 'type' => 'string', 'example' => '02138276106'], + 'CalleeAreaCode' => ['title' => '被叫号码区号', 'description' => '被叫号码区号', 'type' => 'string', 'example' => '010'], + 'EndTime' => ['title' => '电话结束时间，时间戳，精确到s，如1480904471', 'description' => '电话结束时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'Clid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '02138276106'], + 'Cno' => ['title' => '座席工号，如2000', 'description' => '座席工号，如2000', 'type' => 'string', 'example' => '1111'], + 'TrunkGroupKey' => ['title' => '中继群组代号', 'description' => '中继群组代号', 'type' => 'string', 'example' => '30019'], + 'CallType' => ['title' => '呼叫类型 转移', 'description' => '呼叫类型 转移', 'type' => 'string', 'example' => '呼转座席'], + 'Gno' => ['description' => '座席外呼组号', 'type' => 'string', 'example' => 'WH514097'], + 'AnswerTime' => ['title' => '客户接听时间，时间戳，精确到s，如1480904471', 'description' => '客户接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'StatusCode' => ['description' => '呼叫结果码', 'type' => 'string', 'example' => '2'], + 'JoinQueueTime' => ['title' => '入队列时间，时间戳，精确到s，如1480904471', 'description' => '入队列时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'EndReason' => ['title' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'description' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'type' => 'string', 'example' => '1000'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'example' => '131'], + 'RecordFile' => [ + 'description' => '录音文件名数组', + 'type' => 'array', + 'items' => ['description' => '录音文件名', 'type' => 'string', 'example' => '[]'], + 'example' => '', + ], + 'AgentName' => ['description' => '坐席姓名。', 'type' => 'string', 'example' => 'name1'], + 'QueueName' => ['title' => '进入队列时间', 'description' => '进入队列时间', 'type' => 'string', 'example' => '1775024775'], + 'MainCallType' => ['title' => '主通话记录来电类型 主叫外呼', 'description' => '主通话记录来电类型 主叫外呼', 'type' => 'string', 'example' => '主叫外呼'], + 'Status' => ['title' => '外呼结果，如接听', 'description' => '外呼结果，如接听', 'type' => 'string', 'example' => '接听'], + 'UniqueId' => ['title' => '从通道唯一标识', 'description' => '从通道唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'SipCause' => ['title' => 'SIP响应码：200 ~ 699', 'description' => 'SIP响应码：200 ~ 699', 'type' => 'string', 'example' => '200'], + 'XNumber' => ['description' => '虚拟号码', 'type' => 'string', 'example' => '示例值'], + 'CallTypeCode' => ['title' => '呼叫类型编码，如102', 'description' => '呼叫类型编码，如102', 'type' => 'string', 'example' => '102'."\n"], + 'RingingTime' => ['title' => '响铃时间，时间戳，精确到s，如1480904471', 'description' => '响铃时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'CallId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'StartTime' => ['title' => '呼叫客户时间，时间戳，精确到s，如1480904471', 'description' => '呼叫客户时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'SipCauseStr' => ['title' => '呼叫结果', 'description' => '呼叫结果', 'type' => 'string', 'example' => '处理成功'], + 'CalleeNumber' => ['title' => '呼叫的号码，可能是座席也可能是普通电话', 'description' => '呼叫的号码，可能是座席也可能是普通电话', 'type' => 'string', 'example' => '01041003090'], + 'MainUniqueId' => ['title' => '主外呼通话记录唯一标识', 'description' => '主外呼通话记录唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'TotalDuration' => ['title' => '总通话时长秒数，单位是s', 'description' => '总通话时长秒数，单位是s', 'type' => 'string', 'example' => '50'], + 'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => '示例值'], + 'TsiFile' => ['title' => '号码状态识别录音文件名', 'description' => '号码状态识别录音文件名', 'type' => 'string', 'example' => 'name5'], + 'Id' => ['description' => 'Id', 'type' => 'string', 'example' => '797880898'], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席外呼通话记录详情', + 'summary' => '通过本接口，可以根据电话唯一标识查询指定座席外呼通话记录详情。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"DisplayNumber\\": \\"02138276106\\",\\n \\"CalleeAreaCode\\": \\"010\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"1111\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"CallType\\": \\"呼转座席\\",\\n \\"Gno\\": \\"WH514097\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"2\\",\\n \\"JoinQueueTime\\": \\"1775024775\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"131\\",\\n \\"RecordFile\\": [\\n \\"[]\\"\\n ],\\n \\"AgentName\\": \\"name1\\",\\n \\"QueueName\\": \\"1775024775\\",\\n \\"MainCallType\\": \\"主叫外呼\\",\\n \\"Status\\": \\"接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"示例值\\",\\n \\"CallTypeCode\\": \\"102\\\\n\\",\\n \\"RingingTime\\": \\"1775024775\\",\\n \\"CallId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"CalleeNumber\\": \\"01041003090\\",\\n \\"MainUniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"TotalDuration\\": \\"50\\",\\n \\"TaskName\\": \\"示例值\\",\\n \\"TsiFile\\": \\"name5\\",\\n \\"Id\\": \\"797880898\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetQueue' => [ + 'summary' => '查询队列信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'QueryDate', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '通话发生的时间。格式为Unix时间戳，单位：毫秒。'."\n" - ."\n" - .'查询指定时间点之后24小时内的通话记录。'."\n" - ."\n" - .'例如：您输入2022.11.21 20:00:01（时间戳：1669032001000），系统会查询2022.11.21 20:00:01~2022.11.22 20:00:01时间段内指定CallId的呼叫记录。'."\n" - ."\n" - .'> 获取的CallId与**QueryDate**必须是同一天。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1669032001000', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['title' => '队列编号', 'description' => '队列编号', 'type' => 'string', 'required' => true, 'example' => '355'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '返回的呼叫详情。JSON格式。以下字段仅供参考，以具体返回详情为准。'."\n" - .'- **caller**：主叫号码。'."\n" - .'- **startDate**：通话开始时间。'."\n" - .'- **stateDesc**：通话状态描述。'."\n" - .'- **duration**：通话时长。单位：秒。**0**：用户未接通。'."\n" - .'- **callerShowNumber**：被叫显号。'."\n" - .'- **gmtCreate**：通话请求的接收时间。'."\n" - .'- **state**：通话状态。通话状态是运营商实时返回的，更多状态信息，请参见[运营商回执错误码](~~55085~~)。'."\n" - .'- **endDate**：通话结束时间。'."\n" - .'- **calleeShowNumber**：被叫显号。'."\n" - .'- **callee**：被叫号码。'."\n" - .'- **aRingTime**：a路响铃开始时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" - .'- **aEndTime**：a路响铃结束时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" - .'- **bRingTime**：b路响铃开始时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" - .'- **bEndTime**：b路响铃结束时间。格式：yyyy-MM-dd HH:mm:ss。', - 'type' => 'string', - 'example' => '{"caller":"18767****","startDate":"","stateDesc":"502","duration":0,"callerShowNumber":"05344****","gmtCreate":"2017-11-27 20:09:06","state":"502","endDate":"","calleeShowNumber":"053447****","bRingTime":"2022-01-01 12:02:00","bEndTime":"2022-01-01 12:02:28","callee":"1373546****"}', - ], - 'RequestId' => [ - 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'QueueSkills' => [ + 'title' => '队列所需技能数组', + 'description' => '队列所需技能数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-03-30 06:12:33'], + 'QueueId' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '51937'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'example' => '48734'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'integer', 'format' => 'int64', 'example' => '51937'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'Queue' => [ + 'title' => '队列配置信息', + 'description' => '队列配置信息', + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['title' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'description' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'AnnounceSound' => ['title' => '播报固定语音 0关闭 1打开', 'description' => '播报固定语音 0关闭 1打开', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WrapupTime' => ['title' => '整理时间，取值范围3-3600秒', 'description' => '整理时间，取值范围3-3600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'MaxLen' => ['title' => '最大等待数，设置范围0-999，0表示不做任何限制', 'description' => '最大等待数，设置范围0-999，0表示不做任何限制', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Description' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => 'queueName'], + 'AnnouncePosition' => ['title' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'description' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnounceSoundFile' => ['title' => '固定语音文件', 'description' => '固定语音文件', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-03-30 06:12:33'], + 'QueueTimeout' => ['title' => '队列超时时间，取值范围5-600秒，默认600秒', 'description' => '队列超时时间，取值范围5-600秒，默认600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '600'], + 'AnnounceSoundFrequency' => ['title' => '播放固定语音周期，秒数', 'description' => '播放固定语音周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionYouarenext' => ['title' => '是否播报\'您是下一位\',0关闭，1开启', 'description' => '是否播报\'您是下一位\',0关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionParam' => ['title' => '多余少余n个时播报，必须大于等于2', 'description' => '多余少余n个时播报', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MemberTimeout' => ['title' => '座席超时时间，取值范围20-60秒，默认25秒', 'description' => '座席超时时间，取值范围20-60秒，默认25秒', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'Weight' => ['title' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'description' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'JoinEmpty' => ['title' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'description' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'example' => '2632'], + 'MusicClass' => ['title' => '等待语音class', 'description' => '等待语音class', 'type' => 'string', 'example' => 'default'], + 'Strategy' => ['title' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'description' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'type' => 'string', 'example' => 'rrordered'], + 'Id' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '54473'], + 'Retry' => ['title' => '座席超时无应答,呼叫下一座席的延迟秒数', 'description' => '座席超时无应答,呼叫下一座席的延迟秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'SayAgentno' => ['title' => '语音报号，true:播报，false:不播报', 'description' => '语音报号，true:播报，false:不播报', 'type' => 'boolean', 'example' => 'false'], + 'VipSupport' => ['title' => '是否支持vip，1:支持，0:不支持', 'description' => '是否支持vip，1:支持，0:不支持', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionFrequency' => ['title' => '位置播报周期，秒数', 'description' => '位置播报周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"caller\\\\\\":\\\\\\"18767****\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"\\\\\\",\\\\\\"stateDesc\\\\\\":\\\\\\"502\\\\\\",\\\\\\"duration\\\\\\":0,\\\\\\"callerShowNumber\\\\\\":\\\\\\"05344****\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2017-11-27 20:09:06\\\\\\",\\\\\\"state\\\\\\":\\\\\\"502\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"\\\\\\",\\\\\\"calleeShowNumber\\\\\\":\\\\\\"053447****\\\\\\",\\\\\\"bRingTime\\\\\\":\\\\\\"2022-01-01 12:02:00\\\\\\",\\\\\\"bEndTime\\\\\\":\\\\\\"2022-01-01 12:02:28\\\\\\",\\\\\\"callee\\\\\\":\\\\\\"1373546****\\\\\\"}\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryCallDetailByCallIdResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>{\\"caller\\":\\"18767****\\",\\"startDate\\":\\"\\",\\"stateDesc\\":\\"502\\",\\"duration\\":0,\\"callerShowNumber\\":\\"05344****\\",\\"gmtCreate\\":\\"2017-11-27 20:09:06\\",\\"state\\":\\"502\\",\\"endDate\\":\\"\\",\\"calleeShowNumber\\":\\"053447****\\",\\"bRingTime\\":\\"2022-01-01 12:02:00\\"，\\"bEndTime\\":\\"2022-01-01 12:02:28\\"，\\"callee\\":\\"1373546****\\"}</Data>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n</QueryCallDetailByCallIdResponse>","errorExample":""}]', - 'title' => '查询指定通话的呼叫详情', - 'summary' => '根据指定通话任务返回的CallID查询呼叫详情，包括通话开始时间、通话时长、通话状态、通话结束时间、被叫号码等详情。', - 'description' => '- 此接口只支持查询近6个月的数据。'."\n" - .'- 此接口可查询语音通知、语音验证码、语音IVR、智能语音交互、智能外呼机器人的呼叫详情。'."\n" - .'- 由于接口数据同步需要时间，建议您呼叫结束后等待3到5分钟再尝试调用接口。'."\n" - .'- 调用外呼接口发起通话后，返回参数中会携带CallId，使用获取的CallID查询呼叫详情。例：如果您需要查询语音通知的通话记录，请调用[SingleCallByVoice](~~393517~~)发送语音通知后获取CallId。'."\n" - .'- 请求参数**ProdId**和**QueryDate**必须与**CallID**匹配，否则查询到的呼叫详情可能为空。详细匹配规则请参见请求参数描述。'."\n" - .'- 呼叫详情记录不支持跨账号查询，请确保调用本接口的账号与发送外呼通话的账号一致。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'IvrCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取队列信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"QueueSkills\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-03-30 06:12:33\\",\\n \\"QueueId\\": 51937,\\n \\"SkillId\\": 48734,\\n \\"Id\\": 51937,\\n \\"EnterpriseId\\": 7000002\\n }\\n ],\\n \\"Queue\\": {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:33\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 0,\\n \\"MemberTimeout\\": 60,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"2632\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 54473,\\n \\"Retry\\": 5,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 0\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetRecordUrl' => [ + 'summary' => '通过本接口，可以根据录音文件名获取录音试听或下载地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52686', - 'abilityTreeNodes' => [ - 'FEATUREdyvms4MLIJE', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '主叫号码。'."\n" - ."\n" - .'必须是已购买的号码，单次请求仅支持一个主叫号码。一般号码都有并发数，超过并发数会请求失败。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码>真实号管理**页面查看已购买的号码。', - 'type' => 'string', - 'required' => true, - 'example' => '0571****5678', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'CalledNumber', + 'name' => 'RecordType', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。'."\n" - ."\n" - .'仅支持中国内地号码，单次请求仅支持一个号码。', - 'type' => 'string', - 'required' => true, - 'example' => '1590****000', - ], + 'schema' => ['title' => '录音类型，不填可根据 recordFile 解析；record:录音voicemail:留言tsi:彩铃、当开启号码录音状态识别，发起预览外呼，客户号码是手机且客户未接听时返回该地址 rasr:语音机器人客户侧录音 transfer:转接consult:咨询threeway:三方', 'description' => '录音类型，不填可根据 recordFile 解析；record:录音voicemail:留言tsi:彩铃、当开启号码录音状态识别，发起预览外呼，客户号码是手机且客户未接听时返回该地址 rasr:语音机器人客户侧录音 transfer:转接consult:咨询threeway:三方', 'type' => 'string', 'required' => false, 'example' => 'record'], ], [ - 'name' => 'StartCode', + 'name' => 'RecordFile', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫开始时播放的提示音。'."\n" - ."\n" - .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" - .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音消息**>**语音通知**>**文本转语音模板**页面查看**模板ID**。', - 'type' => 'string', - 'required' => true, - 'example' => 'TTS_1234****', - ], + 'schema' => ['title' => '录音文件名；如7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87', 'description' => '录音文件名；如7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87', 'type' => 'string', 'required' => true, 'example' => '7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87'], ], [ - 'name' => 'StartTtsParams', + 'name' => 'RecordFormat', 'in' => 'query', - 'schema' => [ - 'description' => '文本转语音模板内的变量参数，格式为JSON。'."\n" - ."\n" - .'> 当StartCode为文本转语音模板（TTS）且模板中带变量的情况下，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"}', - ], + 'schema' => ['title' => '录音文件类型；取值说明：0为mp3，1为wav，默认为mp3类型', 'description' => '录音文件类型；取值说明：0为mp3，1为wav，默认为mp3类型', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'PlayTimes', + 'name' => 'CallType', 'in' => 'query', - 'schema' => [ - 'description' => '重复播放次数。取值范围为**1~3**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '呼叫类型；说明：开启分线录音时，获取客户侧或座席侧录音需要，recordFormat=1时有效，recordFormat=0时忽略。取值范围：1,2,4,5（数字含义：呼入,webcall,预览外呼,预测外呼）', 'description' => '呼叫类型；说明：开启分线录音时，获取客户侧或座席侧录音需要，recordFormat=1时有效，recordFormat=0时忽略。取值范围：1,2,4,5（数字含义：呼入,webcall,预览外呼,预测外呼）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'], ], [ - 'name' => 'ByeCode', + 'name' => 'RecordSide', 'in' => 'query', - 'schema' => [ - 'description' => '播放结束时播放的结束提示音。支持以下两种方式：'."\n" - ."\n" - .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" - .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**国内语音单呼**>**语音通知**>**文本转语音模板**页面查看**模板ID**。'."\n" - ."\n" - .'> 参数ByeCode的类型需要与参数StartCode一致，即必须同时为语音文件或同时为文本转语音（TTS）模板。', - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_1234****', - ], + 'schema' => ['title' => '分线录音录音侧；说明：开启分线录音时，获取客户侧或座席侧录音需要，recordFormat=1时有效，recordFormat=0时忽略。取值范围：1,2 (数字含义：客户侧，座席侧)recordSide不为空时，callType必选', 'description' => '分线录音侧；说明：开启分线录音时，获取客户侧或座席侧录音需要，recordFormat=1时有效，recordFormat=0时忽略。取值范围：1,2 (数字含义：客户侧，座席侧)recordSide不为空时，callType必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ - 'name' => 'ByeTtsParams', + 'name' => 'Download', 'in' => 'query', + 'schema' => ['title' => '是否下载；１为下载，空或０表示试听', 'description' => '是否下载；１为下载，空或０表示试听', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '文本转语音模板中的变量参数。格式为JSON。'."\n" - ."\n" - .'> 当ByeCode为文本转语音（TTS）模板且模板中带变量的情况下，此参数必填。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"} ', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Url' => ['title' => '试听或下载地址，默认120分钟过期（可配置），过期后，需重新请求接口', 'description' => '试听或下载地址，默认120分钟过期（可配置），过期后，需重新请求接口', 'type' => 'string', 'example' => 'http://voice-1.aliyun.cn/31102016/record/7000000/7000000-2016103111%204742-01087120766-01087120766--record-sip-1-1477885662.222.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161114T100003Z&X-Amz-SignedHeaders=host&X-Amz-Expires=119&X-Amz-Credential=AKIAOTCJOBZFUWFI7FSA%2F20161114%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=0cda4389ecc743acc71d76a320705afd0c175c5ad2286305675c4dee5189b9c8'], + ], + ], + 'Code' => ['description' => '状态码。返回OK代表请求成功', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取通话录音地址', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Url\\": \\"http://voice-1.aliyun.cn/31102016/record/7000000/7000000-2016103111%204742-01087120766-01087120766--record-sip-1-1477885662.222.mp3?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161114T100003Z&X-Amz-SignedHeaders=host&X-Amz-Expires=119&X-Amz-Credential=AKIAOTCJOBZFUWFI7FSA%2F20161114%2Fcn-north-1%2Fs3%2Faws4_request&X-Amz-Signature=0cda4389ecc743acc71d76a320705afd0c175c5ad2286305675c4dee5189b9c8\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudGetTask' => [ + 'summary' => '根据任务Id，获取单个任务的配置信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Timeout', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '等待用户按键超时时间。单位：毫秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3000', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'OutId', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '31'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度为1~15个字节。', - 'type' => 'string', - 'required' => false, - 'example' => 'PR0210428****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '本组参数已弃用，请忽略。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskProperty' => [ + 'title' => '任务配置信息', + 'description' => '任务配置信息', + 'type' => 'object', + 'properties' => [ + 'CallVariables' => ['title' => '座席通道变量，JsonArray格式[{"key1":"value1"},{"key2":"value2"}]', 'description' => '座席通道变量，JsonArray格式[{"key1":"value1"},{"key2":"value2"}]', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'OverTime' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => 'example'], + 'AdjustStep' => ['description' => 'adjustStep', 'type' => 'string', 'example' => '5'], + 'CustomerClidType' => ['title' => '客户侧外显规则，1.随机 2.按区号', 'description' => '客户侧外显规则，1.随机 2.按区号', 'type' => 'string', 'example' => '2'], + 'CustomerVoice' => ['title' => '客户侧提示音', 'description' => '客户侧提示音', 'type' => 'string', 'example' => 'example'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'name1'], + 'Cnos' => ['title' => '座席工号列表', 'description' => '座席工号列表', 'type' => 'string', 'example' => '111,222'], + 'CurlRetryTimes' => ['title' => '已废弃。推送重试次数 最大5次', 'description' => '已废弃。推送重试次数 最大5次', 'type' => 'string', 'example' => '5'], + 'CallbackUrl' => ['title' => '已废弃。给企业推送任务状态的URL地址', 'description' => '已废弃。给企业推送任务状态的URL地址', 'type' => 'string', 'example' => 'deprecated'], + 'Concurrency' => ['title' => '最大并发限制', 'description' => '最大并发限制', 'type' => 'string', 'example' => '0'], + 'StatusDescription' => ['title' => '任务状态描述', 'description' => '任务状态描述', 'type' => 'string', 'example' => '可用座席数小于1'], + 'CustomerClids' => ['title' => '客户侧外显号码列表', 'description' => '客户侧外显号码列表', 'type' => 'string', 'example' => '""'], + 'AutoComplete' => ['title' => '自动完成，0.关闭 1.开启', 'description' => '自动完成，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'AutoStart' => ['title' => '定时开始，0.关闭 1.开启', 'description' => '定时开始，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'CustomerClidWeightFlag' => ['title' => '外显号码比例配置开关，0.关闭 1.开启', 'description' => '外显号码比例配置开关，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'Status' => ['title' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'description' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'type' => 'string', 'example' => '3'], + 'PauseTime' => ['title' => '任务暂停时间点', 'description' => '任务暂停时间点', 'type' => 'string', 'example' => '2026-04-14 16:51:11'], + 'AutoStartDay' => ['title' => '定时开始日期，格式：yyyy-MM-dd，如：2017-02-11', 'description' => '定时开始日期，格式：yyyy-MM-dd，如：2017-02-11', 'type' => 'string', 'example' => '2026-02-11'], + 'ClidProperty' => ['title' => '外显规则，Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'description' => '外显规则，Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'type' => 'string', 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}'], + 'RetryStrategyOnlyToday' => ['title' => '重试仅当天生效，0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据', 'description' => '重试仅当天生效，0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据', 'type' => 'string', 'example' => '0'], + 'WarmUpDuration' => ['title' => '任务预热时间，单位秒', 'description' => '任务预热时间，单位秒', 'type' => 'string', 'example' => '300'], + 'PredictAdjust' => ['title' => '超呼率', 'description' => '超呼率', 'type' => 'string', 'example' => '100'], + 'StartTime' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2025-05-10 14:11:15'], + 'AutoTaskType' => ['title' => '呼叫方式，0.连续呼叫 1.间隔呼叫', 'description' => '呼叫方式，0.连续呼叫 1.间隔呼叫', 'type' => 'string', 'example' => '0'], + 'StandbyCnos' => ['title' => '已废弃', 'description' => '已废弃', 'type' => 'string', 'example' => 'deprecated'], + 'AutoStartTime' => ['title' => '定时开始时间，格式：HH:mm:ss，如：08:00:00', 'description' => '定时开始时间，格式：HH:mm:ss，如：08:00:00', 'type' => 'string', 'example' => '08:00:00'], + 'IsRandom' => ['title' => '随机呼叫，0.关闭 1.开启', 'description' => '随机呼叫，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'ForceEndFlag' => ['title' => '定时完成时强制结束任务。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'description' => '定时完成时强制结束任务。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'type' => 'string', 'example' => '0'], + 'Id' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'string', 'example' => '11059'], + 'Quotiety' => ['title' => '骚扰率，支持小数，精确到小数点两位', 'description' => '骚扰率，支持小数，精确到小数点两位', 'type' => 'string', 'example' => '3.0'], + 'AutoTriggerTimeStrategy' => ['title' => '间隔呼叫时间段，呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'description' => '间隔呼叫时间段，呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'type' => 'string', 'example' => '9,22'], + 'RetryStrategy' => ['title' => '重试策略，「基础模式」数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟「高级模式」高级模式需要开启「号码状态识别」服务后。目前只支持「自动外呼」任务模式。数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致', 'description' => '重试策略，「基础模式」数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟「高级模式」高级模式需要开启「号码状态识别」服务后。目前只支持「自动外呼」任务模式。数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致', 'type' => 'string', 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}'], + 'CustomerTimeout' => ['title' => '客户超时时间，单位秒', 'description' => '客户超时时间，单位秒', 'type' => 'string', 'example' => '30'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'test'], + 'AutoStopDay' => ['title' => '定时完成日期，格式：yyyy-MM-dd，如：2017-02-11', 'description' => '定时完成日期，格式：yyyy-MM-dd，如：2017-02-11', 'type' => 'string', 'example' => '2026-02-11'], + 'TimeStrategy' => ['title' => '禁止呼叫时间限制，在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'description' => '禁止呼叫时间限制，在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'type' => 'string', 'example' => '9,22'], + 'CustomerClidWeight' => ['title' => '外显号码比例配置内容，JsonArray格式[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]', 'description' => '外显号码比例配置内容，JsonArray格式[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]', 'type' => 'string', 'example' => '[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]'], + 'MinAvailableAgentCount' => ['title' => '最小可用座席数', 'description' => '最小可用座席数', 'type' => 'string', 'example' => '1'], + 'AgentTimeout' => ['title' => '座席超时时间，单位秒', 'description' => '座席超时时间，单位秒', 'type' => 'string', 'example' => '10'], + 'AnswerRate' => ['title' => '初始化预计客户接通率', 'description' => '初始化预计客户接通率', 'type' => 'string', 'example' => '100'], + 'CustomerMoh' => ['title' => '客户侧等待音', 'description' => '客户侧等待音', 'type' => 'string', 'example' => 'no'], + 'UserFields' => ['title' => '任务自定义字段，JsonArray格式[{"key1":"value1"},{"key2":"value2"}]', 'description' => '任务自定义字段，JsonArray格式[{"key1":"value1"},{"key2":"value2"}]', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'ClidGroup' => ['title' => '已废弃。热线号码组', 'description' => '已废弃。热线号码组', 'type' => 'string', 'example' => 'deprecated'], + 'CreateTime' => ['title' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'description' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-05-10 14:07:22'], + 'OverCallLimitCnos' => ['description' => '超过接听限制座席', 'type' => 'string', 'example' => '""'], + 'PauseDuration' => ['title' => '任务暂停时长(针对自动启动时间段) 单位分钟', 'description' => '任务暂停时长(针对自动启动时间段) 单位分钟', 'type' => 'string', 'example' => '0'], + 'AutoStop' => ['title' => '定时完成，0.关闭 1.开启', 'description' => '定时完成，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'Wrapup' => ['title' => '座席整理时间，单位秒', 'description' => '座席整理时间，单位秒', 'type' => 'string', 'example' => '30'], + 'MaxWaitTime' => ['title' => '座席最大等待时间，单位秒', 'description' => '座席最大等待时间，单位秒', 'type' => 'string', 'example' => '10'], + 'TaskFields' => ['title' => '已废弃。任务级呼叫属性 json格式{"key1":"value1","key2":"value2"}，仅做呼叫控制用，不放通道变量', 'description' => '已废弃。任务级呼叫属性 json格式{"key1":"value1","key2":"value2"}，仅做呼叫控制用，不放通道变量', 'type' => 'string', 'example' => 'deprecated'], + 'Type' => ['title' => '任务类型，1.预测外呼任务 2.自动外呼任务', 'description' => '任务类型，1.预测外呼任务 2.自动外呼任务', 'type' => 'string', 'example' => '1'], + 'AgentUtilization' => ['title' => '已废弃。座席利用率', 'description' => '已废弃。座席利用率', 'type' => 'string', 'example' => 'deprecated'], + 'IsRewarm' => ['title' => '暂停后重新预热，0.关闭，1开启', 'description' => '暂停后重新预热，0.关闭，1开启', 'type' => 'string', 'example' => '0'], + 'AutoStopTime' => ['title' => '定时完成时间，格式：HH:mm:ss，如：17:00:00', 'description' => '定时完成时间，格式：HH:mm:ss，如：17:00:00', 'type' => 'string', 'example' => '17:00:00'], + 'CallLimitStrategy' => ['title' => '座席当日接听数限制，JsonArray格式[{"cnos":["2000","2001"],"limit":"5"}]', 'description' => '座席当日接听数限制，JsonArray格式[{"cnos":["2000","2001"],"limit":"5"}]', 'type' => 'string', 'example' => '[{"cnos":["2000","2001"],"limit":"5"}]'], + 'CallStrategy' => ['title' => '座席分配规则，1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长）', 'description' => '座席分配规则，1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长）', 'type' => 'string', 'example' => '2'], + 'IvrId' => ['title' => '语音导航Id', 'description' => '语音导航Id', 'type' => 'string', 'example' => '33'], + 'CustomerClidsCategory' => ['title' => '客户侧外显号码类型，1.外显固话 2.外显手机号 4.外显号码池 5.外显导航', 'description' => '客户侧外显号码类型，1.外显固话 2.外显手机号 4.外显号码池 5.外显导航', 'type' => 'string', 'example' => '1'], + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取呼叫任务信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskProperty\\": {\\n \\"CallVariables\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"OverTime\\": \\"example\\",\\n \\"AdjustStep\\": \\"5\\",\\n \\"CustomerClidType\\": \\"2\\",\\n \\"CustomerVoice\\": \\"example\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"Cnos\\": \\"111,222\\",\\n \\"CurlRetryTimes\\": \\"5\\",\\n \\"CallbackUrl\\": \\"deprecated\\",\\n \\"Concurrency\\": \\"0\\",\\n \\"StatusDescription\\": \\"可用座席数小于1\\",\\n \\"CustomerClids\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AutoComplete\\": \\"0\\",\\n \\"AutoStart\\": \\"0\\",\\n \\"CustomerClidWeightFlag\\": \\"0\\",\\n \\"Status\\": \\"3\\",\\n \\"PauseTime\\": \\"2026-04-14 16:51:11\\",\\n \\"AutoStartDay\\": \\"2026-02-11\\",\\n \\"ClidProperty\\": \\"{\\\\\\"defaultAreaCode\\\\\\":\\\\\\"010\\\\\\", \\\\\\"isMatchCapital\\\\\\":\\\\\\"1\\\\\\"}\\",\\n \\"RetryStrategyOnlyToday\\": \\"0\\",\\n \\"WarmUpDuration\\": \\"300\\",\\n \\"PredictAdjust\\": \\"100\\",\\n \\"StartTime\\": \\"2025-05-10 14:11:15\\",\\n \\"AutoTaskType\\": \\"0\\",\\n \\"StandbyCnos\\": \\"deprecated\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"ForceEndFlag\\": \\"0\\",\\n \\"Id\\": \\"11059\\",\\n \\"Quotiety\\": \\"3.0\\",\\n \\"AutoTriggerTimeStrategy\\": \\"9,22\\",\\n \\"RetryStrategy\\": \\"{\\\\\\"retry\\\\\\":2,\\\\\\"strategy\\\\\\":[{\\\\\\"round\\\\\\":1,\\\\\\"time\\\\\\":\\\\\\"1-1-1\\\\\\"},{\\\\\\"round\\\\\\":2,\\\\\\"time\\\\\\":\\\\\\"2-2-2\\\\\\"}]}\\",\\n \\"CustomerTimeout\\": \\"30\\",\\n \\"Description\\": \\"test\\",\\n \\"AutoStopDay\\": \\"2026-02-11\\",\\n \\"TimeStrategy\\": \\"9,22\\",\\n \\"CustomerClidWeight\\": \\"[{\\\\\\"number\\\\\\":\\\\\\"123,345\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"},{\\\\\\"number\\\\\\":\\\\\\"567,789\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"MinAvailableAgentCount\\": \\"1\\",\\n \\"AgentTimeout\\": \\"10\\",\\n \\"AnswerRate\\": \\"100\\",\\n \\"CustomerMoh\\": \\"no\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"ClidGroup\\": \\"deprecated\\",\\n \\"CreateTime\\": \\"2025-05-10 14:07:22\\",\\n \\"OverCallLimitCnos\\": \\"\\\\\\"\\\\\\"\\",\\n \\"PauseDuration\\": \\"0\\",\\n \\"AutoStop\\": \\"0\\",\\n \\"Wrapup\\": \\"30\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"TaskFields\\": \\"deprecated\\",\\n \\"Type\\": \\"1\\",\\n \\"AgentUtilization\\": \\"deprecated\\",\\n \\"IsRewarm\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00\\",\\n \\"CallLimitStrategy\\": \\"[{\\\\\\"cnos\\\\\\":[\\\\\\"2000\\\\\\",\\\\\\"2001\\\\\\"],\\\\\\"limit\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"CallStrategy\\": \\"2\\",\\n \\"IvrId\\": \\"33\\",\\n \\"CustomerClidsCategory\\": \\"1\\"\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudImportTaskTel' => [ + 'summary' => '为外呼任务导入任务号码。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'MenuKeyMap', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'repeatList', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '批次名称', 'description' => '批次名称', 'type' => 'string', 'required' => true, 'example' => '批次名称1'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['title' => '批次Id；传此值表示在批次中增加号码', 'description' => '批次Id；传此值表示在批次中增加号码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '666'], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['title' => '优先级；默认0，值越大越优先，最大999999', 'description' => '优先级；默认0，值越大越优先，最大999999', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'IsRepeat', + 'in' => 'query', + 'schema' => ['title' => '是否排重；0.不排重 1.任务内排重 2.导入号码排重 3.批次内排重，默认为1。注：任务内排重与批次内排重不能同时支持，如果中途切换，则从本次切换开始进行排重。', 'description' => '是否排重，默认为1。'."\n" + .'- 0：不排重'."\n" + .'- 1：任务内排重'."\n" + .'- 2：导入号码排重'."\n" + .'- 3：批次内排重'."\n" + ."\n" + .'> - 任务内排重与批次内排重不能同时支持，如果中途切换，则从本次切换开始进行排重。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'BridgeVoicePath', + 'in' => 'query', + 'schema' => ['title' => '座席接听时自动在双侧播放开场白语音，指定语音变量值；企业语音库里的语音变量值', 'description' => '座席接听时自动在双侧播放开场白语音，指定语音变量值；企业语音库里的语音变量值', 'type' => 'string', 'required' => false, 'example' => 'example'], + ], + [ + 'name' => 'BridgeVoiceType', + 'in' => 'query', + 'schema' => ['title' => '座席接听时自动在双侧播放开场白语音类型；1. 公共语音库；2. 企业语音库，静态话术； 3. 企业语音库，动态话术（座席号），传bridgeVoicePath后生效，默认为3', 'description' => '座席接听时自动在双侧播放开场白语音类型，默认为3。'."\n" + .'- 1：公共语音库；'."\n" + .'- 2：企业语音库，静态话术；'."\n" + .'- 3：企业语音库，动态话术（座席号），传bridgeVoicePath后生效。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'TaskTelList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '按键信息。', + 'title' => '任务号码列表；CtiLinkTaskTel中只有Tel是必选字段，长度大小不超过8MB 注：获取导入失败明细，需配置[事件推送](../字段定义/推送变量和值/预测外呼导入号码失败推送变量.md)', + 'description' => '任务号码列表；CtiLinkTaskTel中只有Tel是必选字段，长度大小不超过8MB 注：获取导入失败明细，需配置[事件推送](../字段定义/推送变量和值/预测外呼导入号码失败推送变量.md)', 'type' => 'array', 'items' => [ - 'description' => '按键信息。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '被叫方可按的电话按键。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'TtsParams' => [ - 'description' => '文本转语音模板内的变量参数，格式为JSON。'."\n" - ."\n" - .'> - 当**MenuKeyMap.N.Code**是文本转语音模板（TTS）时，对应的模板变量替换关系。'."\n" - .'> - 当**MenuKeyMap.N.Code**为文本转语音模板（TTS）且模板中带变量的情况下，此参数为必填。', - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"xxx","code":"123"}', - ], - 'Code' => [ - 'description' => '**MenuKeyMap.N.Key**中指定按键对应的提示音。支持以下两种方式：'."\n" - ."\n" - .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" - .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音消息**>**语音通知**>**文本转语音模板**页面查看**模板ID**。', - 'type' => 'string', - 'required' => false, - 'example' => 'TTS_1235****', - ], + 'ClidGroup' => ['title' => '使用clidGroup需要账号支持按标识路由，使用此参数是clid参数无效', 'description' => '使用clidGroup需要账号支持按标识路由，使用此参数是clid参数无效', 'type' => 'string', 'required' => false, 'example' => 'example'], + 'Clid' => ['title' => '电话号对应的外显号码', 'description' => '电话号对应的外显号码', 'type' => 'string', 'required' => false, 'example' => '7766551'], + 'Priority' => ['title' => '优先级，默认为0，值越大优先级越高，最大999999', 'description' => '优先级，默认为0，值越大优先级越高，最大999999', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '38'], + 'Tel' => ['title' => '电话号', 'description' => '电话号', 'type' => 'string', 'required' => false, 'example' => '7455441'], + 'Property' => ['title' => '属性，json格式', 'description' => '属性，json格式', 'type' => 'string', 'required' => false, 'example' => '{}'], + 'BackupTels' => ['title' => '备选号码，tel呼叫不通时，呼叫备选号码最多支持8个，号码之间用英文逗号","分隔', 'description' => '备选号码，tel呼叫不通时，呼叫备选号码最多支持8个，号码之间用英文逗号","分隔', 'type' => 'string', 'required' => false, 'example' => '7455332'], ], 'required' => false, + 'description' => '', ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 15, + 'required' => true, + 'example' => '', ], ], + [ + 'name' => 'ImportTelAutoStart', + 'in' => 'query', + 'schema' => ['title' => '是否自动启动任务；0:不自动启动 1:自动启动，默认为0', 'description' => '是否自动启动任务，默认为0。'."\n" + .'- 0：不自动启动'."\n" + .'- 1：自动启动', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'CallId' => [ - 'description' => '此次通话的唯一回执ID。'."\n" - ."\n" - .'CallId可以通过[QueryCallDetailByCallId](~~393529~~)接口查询指定通话的呼叫详情。', - 'type' => 'string', - 'example' => '116012354148^10281378****', + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SuccessTotal' => ['title' => '成功导入号码数', 'description' => '成功导入号码数', 'type' => 'string', 'example' => '30'], + 'TaskId' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => '13322333'], + 'ImportTotal' => ['title' => '请求号码总数', 'description' => '请求号码总数', 'type' => 'string', 'example' => '30'], + 'InvalidTotal' => ['title' => '非法号码数', 'description' => '非法号码数', 'type' => 'string', 'example' => '0'], + 'FileId' => ['title' => '批次Id', 'description' => '批次Id', 'type' => 'string', 'example' => '0'], + ], ], + 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => '向指定号码发起交互式语音通话', - 'summary' => '向指定号码发起交互式语音通话。', - 'description' => '- 提交企业资质，并审核通过。具体操作，请参见[提交企业资质](~~149795~~)。'."\n" - .'- 购买语音号码。具体操作，请参见[购买号码](~~149794~~)。'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '任务号码导入', + 'description' => '按批次导入号码，一次导入一个批次。'."\n" ."\n" - .'- 用户接听电话后会听到一段语音，提示用户按键选择。如果开启了[消息回执](~~112503~~)，语音服务会将客户按键信息返回给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。'."\n" + .'限制：一个批次最多10w个号码，一个任务最多100w个号码，一个企业最多1000w个号码。'."\n" ."\n" - .'## QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + .'可创建批次数：≤ 10 万个。'."\n" + .'可导入号码数：≤100 万个。'."\n" + .'单批次可导入号码数：≤ 10 万个。'."\n" + .'超额处理：当触发上述任一限制时，本次请求失败。'."\n" + ."\n" + .'提供「删除任务内号码」接口：业务平台可根据实际情况定期自动删除任务内已完成的批次或号码。'."\n" + .'删除任务内号码后，平台已呼叫过的通话记录明细、录音文件会继续保留。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SuccessTotal\\": \\"30\\",\\n \\"TaskId\\": \\"13322333\\",\\n \\"ImportTotal\\": \\"30\\",\\n \\"InvalidTotal\\": \\"0\\",\\n \\"FileId\\": \\"0\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'SmartCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudInterruptIvr' => [ + 'summary' => '如果当前通话在语音导航的等待节点，通过此接口可以打断等待，执行到下一跳。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2475,1885 +4708,4384 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52713', - 'abilityTreeNodes' => [ - 'FEATUREdyvms59DC26', - ], - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '被叫显号。必须是已购买的号码。'."\n" - ."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码**>**真实号管理**页面查看已购买的号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0571****5678', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'CalledNumber', + 'name' => 'UniqueId', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。仅支持中国内地号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****0000', - ], + 'schema' => ['title' => '通话唯一标识；从通道唯一标识', 'description' => '通话唯一标识；从通道唯一标识', 'type' => 'string', 'required' => true, 'example' => '123456789'], ], [ - 'name' => 'VoiceCode', + 'name' => 'UserField', 'in' => 'query', - 'schema' => [ - 'description' => '智能外呼放音文件。'."\n" - ."\n" - .'当放音文件为控制台上传的语音文件时：参数**VoiceCode**指定为文件的语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**语音文件管理**>**智能语音交互放音文件**，单击**详情**查看对应的**语音ID**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', - ], + 'schema' => ['title' => '自定义字段；json字符串', 'description' => '自定义字段；json字符串', 'type' => 'string', 'required' => false, 'example' => '{}'], ], [ - 'name' => 'RecordFlag', + 'name' => 'CheckName', 'in' => 'query', - 'schema' => [ - 'description' => '通话过程中是否录音。取值：'."\n" - ."\n" - .'- **true**：录音。'."\n" - .'- **false**：不录音。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '根据变量名去通道变量中取对应的变量值', 'description' => '根据变量名去通道变量中取对应的变量值', 'type' => 'string', 'required' => false, 'example' => 'name1'], ], [ - 'name' => 'Volume', + 'name' => 'CheckValue', 'in' => 'query', + 'schema' => ['title' => '当checkName代表的变量值与checkValue一致，才打断', 'description' => '当checkName代表的变量值与checkValue一致，才打断', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '播放用户音频的音量。取值范围：**-4~4**，建议设置为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'IVR等待打断', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAgentGroup' => [ + 'summary' => '通过本接口，可以进行查询获取外呼组列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Speed', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不支持使用。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'AsrModelId', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => 'ASR模型。取值：'."\n" - ."\n" - .'- **customer_service_8k**（默认）：普通话。'."\n" - .'- **dialect_customer_service_8k**：重口音。'."\n" - ."\n" - .'> 调用SmartCall接口时需要指定使用的ASR模型，建议参数AsrModelId和AsrBaseId二者选填其一。'."\n" - .'> - 如果仅设置AsrModelId，表示使用指定的ASR模型。'."\n" - .'> - 如果仅设置AsrBaseId，表示使用指定的ASR基础模型。'."\n" - .'> - 如果二者均未设置，则使用默认的ASR基础模型，即参数AsrBaseId默认为customer_service_8k，表示使用ASR普通话基础模型。'."\n" - .'> - 如果二者同时设置，请确认二者是正确对应的。', - 'type' => 'string', - 'required' => false, - 'example' => 'customer_service_8k', - ], + 'schema' => ['title' => '从第几条开始取；说明：大于等于0，默认0', 'description' => '从第几条开始取；说明：大于等于0，默认0', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'PauseTime', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '停顿时长。用于设置用户停顿多久表示一句话结束。单位：毫秒，取值范围：**300~1200**。'."\n" - ."\n" - .'> - 如果指定值不在参数范围中，则该参数默认取值为**800**。'."\n" - .'> - 该参数首次设置有效，后续设置无效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '800', - ], + 'schema' => ['title' => '需要取出的数据条数；说明：大于0，最大不能超过1000，默认10', 'description' => '需要取出的数据条数；说明：大于0，最大不能超过1000，默认10', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ - 'name' => 'MuteTime', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '静音时长。用于设置用户多久不说话通话结束。单位：毫秒，取值范围：**1000~20000**。'."\n" - ."\n" - .'> - 如果指定值不在参数范围中，则该参数默认取值为**10000**。'."\n" - .'> - 通话过程中可动态设置，以最后一次设置为准。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['title' => '外呼总组名称；说明：以外呼组名称为筛选条件查询', 'description' => '外呼组名称；说明：以外呼组名称为筛选条件查询', 'type' => 'string', 'required' => false, 'example' => 'gpName'], ], [ - 'name' => 'ActionCodeBreak', + 'name' => 'Gno', 'in' => 'query', + 'schema' => ['title' => '外呼总组编号；说明：以外呼组编号为筛选条件查询', 'description' => '外呼组编号；说明：以外呼组编号为筛选条件查询', 'type' => 'string', 'required' => false, 'example' => 'WH123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '当前返回的媒体文件是否可以被打断。默认取值为**true**，即可被打断。'."\n" - ."\n" - .'如果为false，即使下一个动作action_break为true，也无法打断当前放音。'."\n" - ."\n" - .'> action_code_break优先级高于action_break。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '结果信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '外呼组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChildGnos' => ['description' => '子外呼组。', 'type' => 'string', 'example' => '""'], + 'CtiLinkAgentGroup' => [ + 'description' => '外呼组信息', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '外呼组名称', 'description' => '外呼组名称', 'type' => 'string', 'example' => 'gpname1'], + 'Comment' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'comment1'], + 'Type' => ['title' => '外呼组类型 1：外呼总组 2：外呼组', 'description' => '外呼组类型 1：外呼总组 2：外呼组', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Gno' => ['title' => '外呼组编号', 'description' => '外呼组编号', 'type' => 'string', 'example' => 'ZO874912'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600'], + ], + 'example' => '', + ], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取外呼组列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ChildGnos\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CtiLinkAgentGroup\\": {\\n \\"GroupName\\": \\"gpname1\\",\\n \\"Comment\\": \\"comment1\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"ZO874912\\",\\n \\"EnterpriseId\\": 7122600\\n }\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAgentTel' => [ + 'summary' => '通过座席工号获取座席电话信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OutId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方使用的ID。 最终会通过在回执消息中将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度为1~15个字节。', - 'type' => 'string', - 'required' => false, - 'example' => '342268*****', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7122600'], ], [ - 'name' => 'DynamicId', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方使用的动态扩展ID。在回调地址中带回，用于客户的开发标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdefgh', - ], + 'schema' => ['title' => '座席工号；3-10位数字', 'description' => '座席工号；3-10位数字', 'type' => 'string', 'required' => true, 'example' => '1111'], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'Tel', 'in' => 'query', + 'schema' => ['title' => '座席电话', 'description' => '座席电话', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '早媒体语音识别标识。取值：'."\n" - ."\n" - .'- **false**（默认）：关闭。'."\n" - .'- **true**：开启。'."\n" - ."\n" - .'> 设为**true**会记录通话未接听的原因。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '座席电话数组', + 'description' => '座席电话数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IsBind' => ['title' => '是否绑定，0:未绑定 1:绑定', 'description' => '是否绑定，0:未绑定 1:绑定', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '7098'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'AreaCode' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'Tel' => ['title' => '电话号码', 'description' => '电话号码', 'type' => 'string', 'example' => '41008502'], + 'Id' => ['title' => '座席电话id', 'description' => '座席电话id', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'AgentId' => ['title' => '座席id', 'description' => '座席id', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'TelType' => ['title' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'description' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IsValidity' => ['title' => '是否验证，0:未验证 1:已验证', 'description' => '是否验证，0:未验证 1:已验证', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席电话', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"IsBind\\": 1,\\n \\"Cno\\": \\"7098\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"Tel\\": \\"41008502\\",\\n \\"Id\\": 9,\\n \\"AgentId\\": 19,\\n \\"TelType\\": 1,\\n \\"IsValidity\\": 1,\\n \\"EnterpriseId\\": 7122600\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListAssignedAgentGroup' => [ + 'summary' => '通过本接口，可以进行查询获取外呼组下的座席列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'VoiceCodeParam', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'TTS参数传递字符串，格式为JSON。必须与**VoiceCode**的TTS参数对应。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"name":"喂,你好"}', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'SessionTimeout', + 'name' => 'Gno', 'in' => 'query', - 'schema' => [ - 'description' => '最大通话时长，超时后自动挂断。单位：秒。'."\n" - ."\n" - .'> 通话时长最长3600秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['title' => '外呼组编号；说明：获取此gno下绑定的座席信息列表', 'description' => '外呼组编号；说明：获取此gno下绑定的座席信息列表', 'type' => 'string', 'required' => true, 'example' => 'WH113'], ], [ - 'name' => 'ActionCodeTimeBreak', + 'name' => 'Cno', 'in' => 'query', - 'schema' => [ - 'description' => '基于用户持续说话时长打断。单位：毫秒。'."\n" - ."\n" - .'如果当前媒体文件ActionCodeBreak为**true**，用户持续说话可以打断当前播放。不设置或者为0，不生效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['title' => '查询条件座席编号；说明：以座席编号为筛选条件查询', 'description' => '查询条件座席编号；说明：以座席编号为筛选条件查询', 'type' => 'string', 'required' => false, 'example' => '111111111'], ], [ - 'name' => 'TtsStyle', + 'name' => 'Cname', 'in' => 'query', + 'schema' => ['title' => '查询条件座席名称；说明：以座席名称为筛选条件查询', 'description' => '查询条件座席名称；说明：以座席名称为筛选条件查询', 'type' => 'string', 'required' => false, 'example' => '111111111'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'TTS变量播放时的声音风格。默认为**xiaoyun**。具体风格，请参见下表**声音风格列表**。', - 'type' => 'string', - 'required' => false, - 'example' => 'xiaoyun', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['title' => '座席编号', 'description' => '座席编号', 'type' => 'string', 'example' => '59517582'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-03-30 06:12:30'], + 'Gno' => ['title' => '外呼组编号', 'description' => '外呼组编号', 'type' => 'string', 'example' => 'ZO874912'], + 'Cname' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'integer', 'format' => 'int64', 'example' => 'name1'], + 'EnterpriseId' => ['title' => '呼叫中心编号', 'description' => '呼叫中心编号', 'type' => 'string', 'example' => '7122600'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取外呼组下座席组列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"59517582\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:30\\",\\n \\"Gno\\": \\"ZO874912\\",\\n \\"Cname\\": 0,\\n \\"EnterpriseId\\": \\"7122600\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListCurlLog' => [ + 'summary' => '查询用户推送日志。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TtsVolume', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => 'TTS变量播放的音量。取值范围：**0~100**，默认值为**0**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'TtsSpeed', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'TTS变量播放时的声音速度。取值范围：**-200~200**，默认值为**0**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['title' => '推送类型；1:来电推送、2:来电响铃推送、3:外呼响铃推送、4:webcall转座席响铃推送、5:来电接通推送、6:外呼接通推送、7:来电挂机推送、8:外呼挂机推送、9:座席状态推送、10:按键推送、11:号码状态识别推送、12:录音状态推送、13:HTTP交互推送、15:ASR语音转换结果推送、14:预测式外呼任务推送、16:webcall客户侧响铃推送、17:满意度调查推送、18:预测外呼客户接听状态推送、19:NLU推送、20:预测外呼双方接听推送、21:IVR交互结束推送、22:外呼客户响铃推送、23:webcall客户接听推送、24:webcall转接响铃推送、25:webcall转接接通推送、26:主叫外呼分机响铃推送、27:主叫外呼分机接听推送、28:主叫外呼客户响铃推送、29:主叫外呼双方接通推送', 'description' => '推送类型；1:来电推送、2:来电响铃推送、3:外呼响铃推送、4:webcall转座席响铃推送、5:来电接通推送、6:外呼接通推送、7:来电挂机推送、8:外呼挂机推送、9:座席状态推送、10:按键推送、11:号码状态识别推送、12:录音状态推送、13:HTTP交互推送、15:ASR语音转换结果推送、14:预测式外呼任务推送、16:webcall客户侧响铃推送、17:满意度调查推送、18:预测外呼客户接听状态推送、19:NLU推送、20:预测外呼双方接听推送、21:IVR交互结束推送、22:外呼客户响铃推送、23:webcall客户接听推送、24:webcall转接响铃推送、25:webcall转接接通推送、26:主叫外呼分机响铃推送、27:主叫外呼分机接听推送、28:主叫外呼客户响铃推送、29:主叫外呼双方接通推送', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'TtsConf', + 'name' => 'Result', 'in' => 'query', - 'schema' => [ - 'description' => '是否设置TTS声音参数。取值：'."\n" - ."\n" - .'- **true**：设置。需要通过**TtsStyle**、**TtsVolume**、**TtsSpeed**三个参数来设置声音风格。'."\n" - .'- **false**：不设置。不需要设置相关参数，即便设置了也不生效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '推送结果；取值：1、成功，0、失败', 'description' => '推送结果；取值：1、成功，0、失败', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AsrBaseId', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'ASR基础模型。取值：'."\n" - ."\n" - .'- **customer_service_8k**（默认）：普通话。'."\n" - .'- **dialect_customer_service_8k**：重口音。'."\n" - ."\n" - .'> 调用SmartCall接口时需要指定使用的ASR模型，建议参数AsrModelId和AsrBaseId二者选填其一。'."\n" - .'> - 如果仅设置AsrModelId，表示使用指定的ASR模型。'."\n" - .'> - 如果仅设置AsrBaseId，表示使用指定的ASR基础模型。'."\n" - .'> - 如果二者均未设置，则使用默认的ASR基础模型，即参数AsrBaseId默认为customer_service_8k，表示使用ASR普通话基础模型。'."\n" - .'> - 如果二者同时设置，请确认二者是正确对应的。', - 'type' => 'string', - 'required' => false, - 'example' => 'customer_service_8k', - ], + 'schema' => ['title' => '推送的url；说明：目的URL', 'description' => '推送的url；说明：目的URL', 'type' => 'string', 'required' => false, 'example' => '""'], ], [ - 'name' => 'StreamAsr', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '流式ASR，根据用户说的前几个字智能判断语义。取值：'."\n" - ."\n" - .'- **0**：关闭。'."\n" - .'- **1**：开启。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['title' => '查询开始时间；格式:"yyyy-MM-dd HH:mm:ss",精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'description' => '查询开始时间；格式:"yyyy-MM-dd HH:mm:ss",精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'type' => 'string', 'required' => true, 'example' => '2026-04-20 10:00:00'], ], [ - 'name' => 'BackgroundFileCode', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '用户和机器人对话时播放的背景语音文件ID。'."\n" - ."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**语音文件管理**>**智能语音交互放音文件**，单击**详情**按钮，查看对应的语音ID。', - 'type' => 'string', - 'required' => false, - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - ], + 'schema' => ['title' => '查询结束时间；格式:"yyyy-MM-dd HH:mm:ss",精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'description' => '查询结束时间；格式:"yyyy-MM-dd HH:mm:ss",精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'type' => 'string', 'required' => true, 'example' => '2026-04-23 10:00:00'], ], [ - 'name' => 'BackgroundVolume', + 'name' => 'Retry', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不支持使用。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '4', - 'minimum' => '-4', - 'example' => '1', - ], + 'schema' => ['title' => '重试次数；默认-2', 'description' => '重试次数；默认-2', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], ], [ - 'name' => 'BackgroundSpeed', + 'name' => 'Start', 'in' => 'query', - 'schema' => [ - 'description' => '参数暂不支持使用。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '从第几条开始取；大于等于0，默认0', 'description' => '从第几条开始取；大于等于0，默认0', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'EnableITN', + 'name' => 'Limit', 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过500，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过500，默认10', 'type' => 'string', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否在后处理中执行ITN。默认为**false**，即不执行。'."\n" - ."\n" - .'设置为**true**时，中文数字将转为阿拉伯数字输出。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '本组参数已弃用，请忽略。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '返回数据JSON格式', + 'description' => '返回数据JSON格式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UniqueId' => ['title' => '唯一标示', 'description' => '唯一标识', 'type' => 'string', 'example' => '""'], + 'EndTime' => ['title' => '推送结束时间', 'description' => '推送结束时间', 'type' => 'string', 'example' => '1774822137959'], + 'ContentType' => ['title' => '文本类型', 'description' => '文本类型', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Position' => ['title' => '推送位置', 'description' => '推送位置', 'type' => 'string', 'example' => '0'], + 'Timeout' => ['title' => '超时时间', 'description' => '超时时间', 'type' => 'string', 'example' => '3'], + 'Headers' => ['title' => '请求头', 'description' => '请求头', 'type' => 'string', 'example' => '{}'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '1774822134415'], + 'TypeStr' => ['title' => '推送类型字符串', 'description' => '推送类型字符串', 'type' => 'string', 'example' => '主通话记录推送'], + 'StartTime' => ['title' => '推送开始时间', 'description' => '推送开始时间', 'type' => 'string', 'example' => '1774822134132'], + 'Params' => ['title' => '推送参数', 'description' => '推送参数', 'type' => 'string', 'example' => '{\\"bindTel\\":\\"01041000229\\",\\"stateAction\\":\\"idle\\",\\"cno\\":\\"8702\\",\\"bindType\\":\\"1\\",\\"enterpriseId\\":\\"7122600\\",\\"state\\":\\"空闲\\",\\"timeInMillis\\":\\"1774822137188\\",\\"time\\":\\"1774822137\\",\\"event\\":\\"status\\",\\"loginStatus\\":\\"1\\",\\"deviceStatus\\":\\"0\\"}'], + 'RequestTime' => ['title' => '推送时间', 'description' => '推送时间', 'type' => 'string', 'example' => '1774822137191'], + 'Method' => ['title' => '推送方法', 'description' => '推送方法', 'type' => 'string', 'example' => 'GET'], + 'StatusCode' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'], + 'Url' => ['title' => '推送url', 'description' => '推送url', 'type' => 'string', 'example' => 'https://www.aaa.com/index.htm'], + 'Delay' => ['title' => '延迟推送时间', 'description' => '延迟推送时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'EnterpriseId' => ['title' => '企业id', 'description' => '企业id', 'type' => 'string', 'example' => '7122600'], + 'Result' => ['title' => '推送状态', 'description' => '推送状态', 'type' => 'string', 'example' => '1'], + 'Type' => ['title' => '推送类型', 'description' => '推送类型', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'ResultText' => ['title' => '返回文本', 'description' => '返回文本', 'type' => 'string', 'example' => '{\\"stateAction\\":\\"busyAgentOb\\",\\"cno\\":\\"8702\\",\\"bindType\\":\\"1\\",\\"timeInMillis\\":\\"1774822133193\\",\\"loginStatus\\":\\"1\\",\\"customerNumber\\":\\"01042000229\\",\\"callType\\":\\"4\\",\\"deviceStatus\\":\\"4\\",\\"bindTel\\":\\"01041000229\\",\\"mainUniqueId\\":\\"sip-33-1774822127.355\\",\\"enterpriseId\\":\\"7122600\\",\\"state\\":\\"通话\\",\\"time\\":\\"1774822133\\",\\"event\\":\\"status\\",\\"uniqueId\\":\\"sip-33-1774822127.355\\"}'], + 'Level' => ['title' => '推送登记', 'description' => '推送登记', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Retry' => ['title' => '重试次数', 'description' => '重试次数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Id' => ['title' => '日志id', 'description' => '日志id', 'type' => 'string', 'example' => '12715'], + 'CurrentMonth' => ['title' => '当月', 'description' => '当月', 'type' => 'string', 'example' => '""'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '推送日志查询', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"UniqueId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"EndTime\\": \\"1774822137959\\",\\n \\"ContentType\\": 1,\\n \\"Position\\": \\"0\\",\\n \\"Timeout\\": \\"3\\",\\n \\"Headers\\": \\"{}\\",\\n \\"CreateTime\\": \\"1774822134415\\",\\n \\"TypeStr\\": \\"主通话记录推送\\",\\n \\"StartTime\\": \\"1774822134132\\",\\n \\"Params\\": \\"{\\\\\\\\\\\\\\"bindTel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01041000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stateAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"idle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cno\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8702\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enterpriseId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"7122600\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"空闲\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeInMillis\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822137188\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822137\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"event\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"loginStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"deviceStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0\\\\\\\\\\\\\\"}\\",\\n \\"RequestTime\\": \\"1774822137191\\",\\n \\"Method\\": \\"GET\\",\\n \\"StatusCode\\": \\"200\\",\\n \\"Url\\": \\"https://www.aaa.com/index.htm\\",\\n \\"Delay\\": 0,\\n \\"EnterpriseId\\": \\"7122600\\",\\n \\"Result\\": \\"1\\",\\n \\"Type\\": 9,\\n \\"ResultText\\": \\"{\\\\\\\\\\\\\\"stateAction\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"busyAgentOb\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"cno\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8702\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"timeInMillis\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822133193\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"loginStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"customerNumber\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01042000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"callType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"deviceStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"bindTel\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"01041000229\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mainUniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sip-33-1774822127.355\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"enterpriseId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"7122600\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"state\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"通话\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"time\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1774822133\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"event\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"uniqueId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sip-33-1774822127.355\\\\\\\\\\\\\\"}\\",\\n \\"Level\\": 0,\\n \\"Retry\\": 0,\\n \\"Id\\": \\"12715\\",\\n \\"CurrentMonth\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListExten' => [ + 'summary' => '查询分机信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'NoiseThreshold', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'type' => 'number', - 'format' => 'double', - 'required' => false, - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Exten', + 'in' => 'query', + 'schema' => ['title' => '分机号', 'description' => '分机号', 'type' => 'string', 'required' => false, 'example' => '9000'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'JitterBuffer', + 'in' => 'query', + 'schema' => ['title' => '网络防抖', 'description' => '网络防抖', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'description' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'IsBind', + 'in' => 'query', + 'schema' => ['title' => '是否被座席绑定，1 绑定 0未绑定', 'description' => '是否被座席绑定，1 绑定 0未绑定', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '条数；正整数 大于0 小于等于500 默认为10条', 'description' => '条数；正整数 大于0 小于等于500 默认为10条', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始；正整数 默认为0', 'description' => '从第几条开始；正整数 默认为0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - ], - 'CallId' => [ - 'description' => '此次通话的唯一回执ID。'."\n" - ."\n" - .'CallId可以通过[QueryCallDetailByCallId](~~QueryCallDetailByCallId~~)接口查询呼叫详情。', - 'type' => 'string', - 'example' => '116012854210^10281427****', + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderBy' => ['description' => '排序字段', 'type' => 'string', 'example' => 'exten'], + 'NavigatepageNums' => [ + 'description' => '废弃参数可忽略', + 'type' => 'array', + 'items' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '1'], + 'example' => '', + ], + 'FirstPage' => ['description' => '第一页', 'type' => 'string', 'example' => '1'], + 'PrePage' => ['description' => '前一页', 'type' => 'string', 'example' => '0'], + 'PageNum' => ['description' => '当前页', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '页容量', 'type' => 'string', 'example' => '10'], + 'EndRow' => ['description' => '结束行', 'type' => 'string', 'example' => '3'], + 'IsLastPage' => ['description' => '是否为最后一页。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'], + 'Size' => ['description' => '当前页数量', 'type' => 'string', 'example' => '3'], + 'IsFirstPage' => ['description' => '是否为第一页。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'], + 'HasPreviousPage' => ['description' => '是否有前一页。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'], + 'StartRow' => ['description' => '起始行', 'type' => 'string', 'example' => '1'], + 'Pages' => ['description' => '总页数', 'type' => 'string', 'example' => '1'], + 'NavigatePages' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => 'example'], + 'Total' => ['description' => '总条数。', 'type' => 'string', 'example' => '3'], + 'List' => [ + 'description' => '分机列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'JitterBuffer' => ['title' => '网络防抖', 'description' => '网络防抖', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2026-03-30 06:09:02'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Exten' => ['title' => '分机号,3-11位', 'description' => '分机号,3-11位', 'type' => 'string', 'example' => '66749'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'string', 'example' => '7000002'], + 'Allow' => ['title' => '允许的语音编码,支持格式: 1. g729 2. g729,alaw,ulaw 3. alaw,ulaw,g729 4. alaw,ulaw 5. myopus,alaw,ulaw 公网+远程话机支持配置1/2/3;专线+远程话机支持配置1/2;公网+软电话支持配置4;专线+软电话支持配置5;', 'description' => '允许的语音编码,支持格式: 1. g729 2. g729,alaw,ulaw 3. alaw,ulaw,g729 4. alaw,ulaw 5. myopus,alaw,ulaw 公网+远程话机支持配置1/2/3;专线+远程话机支持配置1/2;公网+软电话支持配置4;专线+软电话支持配置5;', 'type' => 'string', 'example' => 'alaw,ulaw'], + 'Type' => ['title' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'description' => '类型，1. 注册到IAD分机 2.注册到webrtc 3.注册到远程话机', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AreaCode' => ['title' => '区号', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'Denoise' => ['title' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'description' => '降噪开关 0:关闭 1:开启 默认关闭(该参数只有在类型为注册到webrtc才有效)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Id' => ['title' => '分机号id', 'description' => '分机号id', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], + 'IsDirect' => ['title' => '是否允许摘机外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许摘机外呼，0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Password' => ['title' => '密码', 'description' => '密码', 'type' => 'string', 'example' => 'Aa626670'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'NextPage' => ['description' => '下一页', 'type' => 'string', 'example' => '0'], + 'LastPage' => ['description' => '最后一页', 'type' => 'string', 'example' => '1'], + 'HasNextPage' => ['description' => '是否有下一页。', 'type' => 'integer', 'format' => 'int64', 'example' => 'false'], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"CallId\\": \\"116012854210^10281427****\\"\\n}","errorExample":""},{"type":"xml","example":"<SmartCallResponse>\\n<Message>OK</Message>\\n<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n<CallId>116012854210^10281427****</CallId>\\n<Code>OK</Code>\\n</SmartCallResponse>","errorExample":""}]', - 'title' => '发起智能语音交互通话', - 'summary' => '智能语音交互服务，是一种人机交互技术，它允许用户通过语音与机器进行自然的对话和沟通。', - 'description' => '- SmartCall需要与[智能外呼回调HTTP接口](~~112703~~)联合使用，语音平台发起呼叫后会把转换后的语音文本回传给业务方，业务方把下一步的执行动作返回给语音平台。'."\n" - .'- 以下字符不可以在智能语音交互SmartCall回调中出现：`@ = : "" $ { } ^ * ￥`。', - 'requestParamsDescription' => '### 声音风格'."\n" - .'更多声音风格详情，请参见[声音风格列表](https://help.aliyun.com/zh/vms/sound-style)。', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SmartCallOperate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取分机列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OrderBy\\": \\"exten\\",\\n \\"NavigatepageNums\\": [\\n \\"1\\"\\n ],\\n \\"FirstPage\\": \\"1\\",\\n \\"PrePage\\": \\"0\\",\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"EndRow\\": \\"3\\",\\n \\"IsLastPage\\": 0,\\n \\"Size\\": \\"3\\",\\n \\"IsFirstPage\\": 0,\\n \\"HasPreviousPage\\": 0,\\n \\"StartRow\\": \\"1\\",\\n \\"Pages\\": \\"1\\",\\n \\"NavigatePages\\": \\"example\\",\\n \\"Total\\": \\"3\\",\\n \\"List\\": [\\n {\\n \\"JitterBuffer\\": 0,\\n \\"CallPower\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-03-30 06:09:02\\",\\n \\"IbRecord\\": 1,\\n \\"Exten\\": \\"66749\\",\\n \\"ObRecord\\": 1,\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Allow\\": \\"alaw,ulaw\\",\\n \\"Type\\": 2,\\n \\"AreaCode\\": \\"010\\",\\n \\"Denoise\\": 0,\\n \\"Id\\": 59,\\n \\"IsDirect\\": 1,\\n \\"Password\\": \\"Aa626670\\",\\n \\"IsOb\\": 1\\n }\\n ],\\n \\"NextPage\\": \\"0\\",\\n \\"LastPage\\": \\"1\\",\\n \\"HasNextPage\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListFreeAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52714', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'EnterpriseId', 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '通话的唯一回执ID。可通过[SmartCall](~~393526~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'example' => '116012854210^1028142****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '座席工号名称列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['title' => '座席编号', 'description' => '座席编号', 'type' => 'string', 'example' => '1111'], + 'Name' => ['title' => '座席名', 'description' => '座席名', 'type' => 'string', 'example' => '李四'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取在线空闲', + 'summary' => '查询在线的座席列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"1111\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListOnlineAgent' => [ + 'summary' => '查询在线的座席信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Command', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n" - ."\n" - .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。', - 'type' => 'string', - 'required' => true, - 'example' => 'parallelBridge', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'Param', + 'name' => 'Qnos', 'in' => 'query', - 'schema' => [ - 'description' => '扩展字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'Param', - ], + 'schema' => ['title' => '队列号，指定队列号则查询该队列号所对应队列的监控信息，支持同时查询多个队列号对应队列的监控信息，多个队列号使用英文逗号","分隔，不指定则查询所有队列监控信息', 'description' => '队列号，指定队列号则查询该队列号所对应队列的监控信息，支持同时查询多个队列号对应队列的监控信息，多个队列号使用英文逗号","分隔，不指定则查询所有队列监控信息', 'type' => 'string', 'required' => false, 'example' => '123,124'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '坐席工号，指定座席工号则查询该工号座席的监控信息，可指定多个座席工号，指定多个座席工号使用英文逗号","分隔，不指定则查询所有队列监控信息，不指定则查询该账户下所有座席的监控信息', 'description' => '坐席工号，指定座席工号则查询该工号座席的监控信息，可指定多个座席工号，指定多个座席工号使用英文逗号","分隔，不指定则查询所有队列监控信息，不指定则查询该账户下所有座席的监控信息', 'type' => 'string', 'required' => false, 'example' => '1111,1112'], + ], + [ + 'name' => 'StateCode', + 'in' => 'query', + 'schema' => ['title' => '坐席状态，s1:空闲，s2:置忙，s3:整理，s4:呼叫中，s5:响铃，s6通话 可传多个状态码，多个值之间以","分隔', 'description' => '坐席状态，s1:空闲，s2:置忙，s3:整理，s4:呼叫中，s5:响铃，s6通话 可传多个状态码，多个值之间以","分隔', 'type' => 'string', 'required' => false, 'example' => 's1'], + ], + [ + 'name' => 'PauseType', + 'in' => 'query', + 'schema' => ['title' => '置忙类型，根据座席置忙类型过滤监控数据，可指定多个置忙类型，指定多个置忙类型使用英文逗号","分隔，不指定则默认查询所有设置状态的座席。<br>取值说明1普通，2休息，3 IM，4 强制', 'description' => '置忙类型，根据座席置忙类型过滤监控数据，可指定多个置忙类型，指定多个置忙类型使用英文逗号","分隔，不指定则默认查询所有设置状态的座席。<br>取值说明1普通，2休息，3 IM，4 强制', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PauseDescription', + 'in' => 'query', + 'schema' => ['title' => '置忙原因，根据座席置忙原因过滤监控数据，可指定多个置忙原因，指定多个置忙原因使用英文逗号","分隔，不指定则默认查询所有设置状态的座席', 'description' => '置忙原因，根据座席置忙原因过滤监控数据，可指定多个置忙原因，指定多个置忙原因使用英文逗号","分隔，不指定则默认查询所有设置状态的座席', 'type' => 'string', 'required' => false, 'example' => '示例值'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '命令执行的结果。取值：'."\n" - .'- **true**：命令执行成功。'."\n" - .'- **false**：命令执行失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'AgentStatuses' => [ + 'title' => '座席状态数组', + 'description' => '座席状态数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LoginStatusDuration' => ['title' => '登录状态时长', 'description' => '登录状态时长', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'LoginTime' => ['title' => '登录时间', 'description' => '登录时间', 'type' => 'string', 'example' => '1774821736'], + 'DeviceStatusDuration' => ['title' => '设备状态时长', 'description' => '设备状态时长', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'State' => ['title' => '座席状态（结合了登录状态和设备状态），失效，空闲，置忙，整理，呼叫中，响铃，通话', 'description' => '座席状态（结合了登录状态和设备状态），失效，空闲，置忙，整理，呼叫中，响铃，通话', 'type' => 'string', 'example' => '空闲'], + 'LoginStatus' => ['title' => '登录状态，0离线，1在线，2置忙，3整理', 'description' => '登录状态，0离线，1在线，2置忙，3整理', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'DeviceStatus' => ['title' => '设备状态，-1 失效，0 空闲，1 已锁定，2 呼叫中，3 响铃，4 通话中', 'description' => '设备状态，-1 失效，0 空闲，1 已锁定，2 呼叫中，3 响铃，4 通话中', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BindTel' => ['title' => '绑定电话', 'description' => '绑定电话', 'type' => 'string', 'example' => '22223333'], + 'Name' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => '李四'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取在线座席信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"<SmartCallOperateResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</SmartCallOperateResponse>","errorExample":""}]', - 'title' => '发起智能语音指定动作', - 'summary' => '在智能外呼通话中发起指定动作，仅用于并行转人工、人工坐席可旁听人机对话等场景。', - 'description' => '在智能语音交互呼出通话中，转接呼叫中心坐席时，可以使用本接口指定被叫号码发起指定动作。'."\n" - ."\n" - .'> 当前仅支持指定动作为被叫号码与呼叫中心坐席桥接。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AgentStatuses\\": [\\n {\\n \\"LoginStatusDuration\\": 7,\\n \\"LoginTime\\": \\"1774821736\\",\\n \\"DeviceStatusDuration\\": 0,\\n \\"Cno\\": \\"1111\\",\\n \\"State\\": \\"空闲\\",\\n \\"LoginStatus\\": 1,\\n \\"DeviceStatus\\": 0,\\n \\"BindTel\\": \\"22223333\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'CreateRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CloudListQueue' => [ + 'summary' => '查询队列信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '任务名称。支持中文和英文，不超过30个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '任务测试', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'DialogId', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '指定机器人ID，即话术ID。表示选择哪个机器人话术发起呼叫。'."\n" - ."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**智能语音机器人**>**话术管理**查看话术ID。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000023****', - ], + 'schema' => ['title' => '条数；正整数，大于0，最大不能超过500， 默认为500', 'description' => '条数；正整数，大于0，最大不能超过500， 默认为500', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500'], ], [ - 'name' => 'CorpName', + 'name' => 'Offset', 'in' => 'query', - 'schema' => [ - 'description' => '公司名称。需和资质管理页面中的**企业名称**完全一致。', - 'type' => 'string', - 'required' => false, - 'example' => '阿里巴巴通信技术（北京）有限公司', - ], + 'schema' => ['title' => '第几条开始；正整数 大于等于0 默认为0', 'description' => '第几条开始；正整数 大于等于0 默认为0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'Caller', + 'name' => 'Qno', 'in' => 'query', - 'schema' => [ - 'description' => '外呼主叫号码。'."\n" - ."\n" - .'必须是已购买的号码，多个号码使用半角逗号（,）隔开。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码**>**真实号管理**页面查看已购买的号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0571****5678', - ], + 'schema' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'required' => false, 'example' => '233'], ], [ - 'name' => 'NumberStatusIdent', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '是否启用号码状态（早媒体）识别标识。取值：'."\n" - ."\n" - .'- **false**（默认值）：不启用。'."\n" - .'- **true**：启用。'."\n" - ."\n" - .'> 设为**true**会记录通话未接听的原因。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => '描述'], ], [ - 'name' => 'RetryType', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => '是否自动重拨。取值：'."\n" - ."\n" - .'- **1**：重拨。'."\n" - .'- **0**：不重拨。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['title' => '排序方式,按照创建时间排序；0正序 1倒序', 'description' => '排序方式,按照创建时间排序；0正序 1倒序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'RecallStateCodes', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '需要重拨的通话状态。多个状态使用半角逗号（,）分隔。取值：'."\n" - ."\n" - .'- **200010**：关机。'."\n" - .'- **200011**：停机。'."\n" - .'- **200002**：占线。'."\n" - .'- **200012**：呼损。'."\n" - .'- **200005**：无法接通。'."\n" - .'- **200003**：无应答。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200010,200011', - ], + 'schema' => ['title' => '创建时间起始时间点；取值说明："2019-10-11 00:00:00"', 'description' => '创建时间起始时间点；取值说明："2019-10-11 00:00:00"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], ], [ - 'name' => 'RecallTimes', + 'name' => 'EndTime', 'in' => 'query', + 'schema' => ['title' => '创建时间终止时间点；取值说明："2019-10-11 23:59:59"', 'description' => '创建时间终止时间点；取值说明："2019-10-11 23:59:59"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 23:00:00'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '重拨次数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '23'], + 'List' => [ + 'title' => '队列列表', + 'description' => '队列列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['title' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'description' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'AnnounceSound' => ['title' => '播报固定语音 0关闭 1打开', 'description' => '播报固定语音 0关闭 1打开', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WrapupTime' => ['title' => '整理时间，取值范围3-3600秒', 'description' => '整理时间，取值范围3-3600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'MaxLen' => ['title' => '最大等待数，设置范围0-999，0表示不做任何限制', 'description' => '最大等待数，设置范围0-999，0表示不做任何限制', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Description' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => 'queueName'], + 'AnnouncePosition' => ['title' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'description' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnounceSoundFile' => ['title' => '固定语音文件', 'description' => '固定语音文件', 'type' => 'string', 'example' => '""'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-09-06 15:50:18'], + 'QueueTimeout' => ['title' => '队列超时时间，取值范围5-600秒，默认600秒', 'description' => '队列超时时间，取值范围5-600秒，默认600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '600'], + 'AnnounceSoundFrequency' => ['title' => '播放固定语音周期，秒数', 'description' => '播放固定语音周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionYouarenext' => ['title' => '是否播报\'您是下一位\',0关闭，1开启', 'description' => '是否播报\'您是下一位\',0关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionParam' => ['title' => '多余少余n个时播报，必须大于等于2', 'description' => '多余少余n个时播报', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'MemberTimeout' => ['title' => '座席超时时间，取值范围20-60秒，默认25秒', 'description' => '座席超时时间，取值范围20-60秒，默认25秒', 'type' => 'integer', 'format' => 'int64', 'example' => '25'], + 'Weight' => ['title' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'description' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'JoinEmpty' => ['title' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'description' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'example' => '33'], + 'MusicClass' => ['title' => '等待语音class', 'description' => '等待语音class', 'type' => 'string', 'example' => 'default'], + 'Strategy' => ['title' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'description' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'type' => 'string', 'example' => 'rrmemory'], + 'Id' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '48175'], + 'Retry' => ['title' => '座席超时无应答,呼叫下一座席的延迟秒数', 'description' => '座席超时无应答,呼叫下一座席的延迟秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SayAgentno' => ['title' => '语音报号，true:播报，false:不播报', 'description' => '语音报号，true:播报，false:不播报', 'type' => 'boolean', 'example' => 'false'], + 'VipSupport' => ['title' => '是否支持vip，1:支持，0:不支持', 'description' => '是否支持vip，1:支持，0:不支持', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnnouncePositionFrequency' => ['title' => '位置播报周期，秒数', 'description' => '位置播报周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取队列列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Total\\": 23,\\n \\"List\\": [\\n {\\n \\"ServiceLevel\\": 10,\\n \\"AnnounceSound\\": 0,\\n \\"WrapupTime\\": 10,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queueName\\",\\n \\"AnnouncePosition\\": 0,\\n \\"AnnounceSoundFile\\": \\"\\\\\\"\\\\\\"\\",\\n \\"CreateTime\\": \\"2025-09-06 15:50:18\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 0,\\n \\"AnnouncePositionYouarenext\\": 0,\\n \\"AnnouncePositionParam\\": 0,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 1,\\n \\"JoinEmpty\\": 0,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"33\\",\\n \\"MusicClass\\": \\"default\\",\\n \\"Strategy\\": \\"rrmemory\\",\\n \\"Id\\": 48175,\\n \\"Retry\\": 1,\\n \\"SayAgentno\\": false,\\n \\"VipSupport\\": 0,\\n \\"AnnouncePositionFrequency\\": 0\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListQueueSkill' => [ + 'summary' => '获取队列技能信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'RecallInterval', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '重拨间隔。单位：分钟，必须大于1。'."\n" - ."\n" - .'> 最大间隔为30分钟。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'IsSelfLine', + 'name' => 'Qno', 'in' => 'query', - 'schema' => [ - 'description' => '是否调用自有线路。取值：'."\n" - ."\n" - .'- **false**（默认值）：不调用。'."\n" - .'- **true**：调用。'."\n" - ."\n" - .'> 设为**true**不会对主叫号码做校验。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'required' => true, 'example' => '1000'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他状态码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '机器人呼叫任务的唯一任务ID。'."\n" - ."\n" - .'任务ID可以通过[QueryRobotTaskDetail](~~393538~~)接口查询任务详情。', - 'type' => 'string', - 'example' => '400111****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'integer', 'format' => 'int64', 'example' => '26'], + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'QueueId' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'example' => '44'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'integer', 'format' => 'int64', 'example' => '93'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '呼叫中心Id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"400111****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', - 'title' => '发起智能语音机器人外呼任务', - 'summary' => '发起智能语音机器人外呼任务。', - 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'- 本接口用于直接使用控制台预设的机器人话术发起机器人外呼任务。在智能语音交互通话中，支持使用控制台预设的机器人话术，或在每轮通话中通过回调接口返回业务方设置的回应方式。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchRobotSmartCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取队列技能', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Qno\\": 26,\\n \\"SkillLevel\\": 5,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueId\\": 33,\\n \\"SkillId\\": 44,\\n \\"Id\\": 93,\\n \\"EnterpriseId\\": 7000002\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '被叫显号，必须是已购买的号码。您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)查看已购买的号码。'."\n" - ."\n" - .'支持设置1~100个被叫显号，号码之间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '136****0000,138****0000', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'CorpName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '公司名称，必须和[资质管理页面](https://dyvms.console.aliyun.com/dyvms.htm#/corp/normal)中的**公司名称**完全一致。'."\n" - ."\n" - .'> 如果开通了**自有线路**功能，即**isSelfLine**为**true**时，该参数为可选。反之则必须填写公司名称。', - 'type' => 'string', - 'required' => false, - 'example' => '阿里巴巴通信技术（北京）有限公司 ', - ], + 'schema' => ['title' => '技能名称', 'description' => '技能名称', 'type' => 'string', 'required' => false, 'example' => 'name1'], ], [ - 'name' => 'CalledNumber', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。仅支持中国大陆号码。'."\n" - ."\n" - .'支持设置1~1000个被叫号码，号码之间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => '1390000****', - ], + 'schema' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'required' => false, 'example' => 'comment1'], ], [ - 'name' => 'DialogId', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => '指定机器人ID，即话术ID。表示选择哪个机器人/话术发起呼叫。'."\n" - ."\n" - .'请在[话术管理页面](https://dyvms.console.aliyun.com/patter/list)中查看**话术ID**。', - 'type' => 'string', - 'required' => true, - 'example' => '100002970****', - ], + 'schema' => ['title' => '条数；正整数，默认值是10，最大值是500', 'description' => '条数；正整数，默认值是10，最大值是500', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'Offset', 'in' => 'query', - 'schema' => [ - 'description' => '早媒体语音识别标识。默认为**false**，即不启用。'."\n" - ."\n" - .'如果需要启用早媒体语音识别标识，请设置为**true**。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '从第几条开始；正整数，默认值是0', 'description' => '从第几条开始；正整数，默认值是0', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ - 'name' => 'TaskName', + 'name' => 'Order', 'in' => 'query', + 'schema' => ['title' => '排序方式,按照创建时间排序；0正序 1倒序', 'description' => '排序方式,按照创建时间排序；0正序 1倒序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '任务名称。'."\n" - ."\n" - .'- 支持中文和英文。'."\n" - ."\n" - .'- 长度限制为：0~30个字符。', - 'type' => 'string', - 'required' => true, - 'example' => '批量外呼任务 ', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'OrderBy' => ['description' => '排序字段', 'type' => 'string', 'example' => '""'], + 'NavigatepageNums' => [ + 'description' => '此参数可忽略', + 'type' => 'array', + 'items' => ['description' => '此参数可忽略', 'type' => 'string', 'example' => '""'], + 'example' => '', + ], + 'FirstPage' => ['description' => '第一页', 'type' => 'string', 'example' => '1'], + 'PrePage' => ['description' => '前一页', 'type' => 'string', 'example' => '0'], + 'PageNum' => ['description' => '当前页', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'string', 'example' => '10'], + 'EndRow' => ['description' => '结束行', 'type' => 'string', 'example' => '4'], + 'IsLastPage' => ['description' => '是否为最后一页。', 'type' => 'boolean', 'example' => 'true'], + 'Size' => ['description' => '当前页数量', 'type' => 'string', 'example' => '4'], + 'IsFirstPage' => ['description' => '是否为第一页。', 'type' => 'boolean', 'example' => 'true'], + 'HasPreviousPage' => ['description' => '是否有前一页。', 'type' => 'boolean', 'example' => 'false'], + 'StartRow' => ['description' => '起始行', 'type' => 'string', 'example' => '1'], + 'Pages' => ['description' => '总页数', 'type' => 'string', 'example' => '1'], + 'NavigatePages' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '""'], + 'Total' => ['description' => '总条数。', 'type' => 'string', 'example' => '4'], + 'List' => [ + 'description' => '技能列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Comment' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => '描述'], + 'CreateTime' => ['title' => '创建时间,精确到秒', 'description' => '创建时间,精确到秒', 'type' => 'string', 'example' => '2026-03-30 06:12:41'], + 'Id' => ['title' => '技能id', 'description' => '技能id', 'type' => 'integer', 'format' => 'int64', 'example' => '52593'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7122600'], + 'Name' => ['title' => '技能名称', 'description' => '技能名称', 'type' => 'string', 'example' => '2902JnD更新技能'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'NextPage' => ['description' => '下一页', 'type' => 'string', 'example' => '0'], + 'LastPage' => ['description' => '最后一页', 'type' => 'string', 'example' => '1'], + 'HasNextPage' => ['description' => '是否有下一页。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询技能列表', + 'summary' => '查询技能信息列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OrderBy\\": \\"\\\\\\"\\\\\\"\\",\\n \\"NavigatepageNums\\": [\\n \\"\\\\\\"\\\\\\"\\"\\n ],\\n \\"FirstPage\\": \\"1\\",\\n \\"PrePage\\": \\"0\\",\\n \\"PageNum\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"EndRow\\": \\"4\\",\\n \\"IsLastPage\\": true,\\n \\"Size\\": \\"4\\",\\n \\"IsFirstPage\\": true,\\n \\"HasPreviousPage\\": false,\\n \\"StartRow\\": \\"1\\",\\n \\"Pages\\": \\"1\\",\\n \\"NavigatePages\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Total\\": \\"4\\",\\n \\"List\\": [\\n {\\n \\"Comment\\": \\"描述\\",\\n \\"CreateTime\\": \\"2026-03-30 06:12:41\\",\\n \\"Id\\": 52593,\\n \\"EnterpriseId\\": 7122600,\\n \\"Name\\": \\"2902JnD更新技能\\"\\n }\\n ],\\n \\"NextPage\\": \\"0\\",\\n \\"LastPage\\": \\"1\\",\\n \\"HasNextPage\\": true\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudListTaskFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ScheduleTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '预设的呼叫时间。Unix时间戳格式，单位为毫秒。'."\n" - ."\n" - .'> 当参数**ScheduleCall**为**true**时必选。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'ScheduleCall', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '是否定时呼叫。如果设置为**true**，则必须设置**ScheduleTime**。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '27'], ], [ - 'name' => 'TtsParam', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'TTS模板的变量值，格式为JSON。'."\n" - ."\n" - .'必须和具体的号码对应，TtsParam与TtsParamHead变量名称一一对应。', - 'type' => 'string', - 'required' => false, - 'example' => '[{"number":"1390000****","params":[“小王”,"小李","小周"]}]', - ], + 'schema' => ['title' => '批次状态；说明：0：未导入，1：导入完成 ，2：加载到缓存，3：呼叫完', 'description' => '批次状态；说明：0：未导入，1：导入完成 ，2：加载到缓存，3：呼叫完', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'TtsParamHead', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '带变量的呼叫任务，格式为JSON。'."\n" - ."\n" - .'变量名称列表，与TtsParam配合使用。', - 'type' => 'string', - 'required' => false, - 'example' => '["name1","name2","name3"]', - ], + 'schema' => ['title' => '说明：统计日期的开始时间，格式：yyyy-MM-dd HH:mm:ss', 'description' => '说明：统计日期的开始时间，格式：yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], ], [ - 'name' => 'IsSelfLine', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '是否调用自有线路，默认为**false**，即不调用。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '说明：统计日期的结束时间，格式：yyyy-MM-dd HH:mm:ss, 最大查询范围1个月', 'description' => '说明：统计日期的结束时间，格式：yyyy-MM-dd HH:mm:ss, 最大查询范围1个月', 'type' => 'string', 'required' => false, 'example' => '2026-05-20 10:00:00'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '查询起始位置；取值：大于等于0，默认0', 'description' => '查询起始位置；取值：大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '查询条数；取值：最大不能超过5000，默认10', 'description' => '查询条数；取值：最大不能超过5000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'TaskId' => [ - 'description' => '机器人呼叫任务的唯一任务ID，可以通过此ID调用[QueryCallDetailByTaskId](~~393537~~)接口查询任务详情。', - 'type' => 'string', - 'example' => '4001112222', + 'AccessDeniedDetail' => ['description' => '本组参数已弃用，请忽略。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总任务批次数量。', 'type' => 'string', 'example' => '1'], + 'TaskFileList' => [ + 'title' => '任务批次信息', + 'description' => '任务批次信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '批次状态，0：未导入，1：导入完成 ，2：加载到缓存，3：呼叫完，4：已冻结', 'description' => '批次状态，0：未导入，1：导入完成 ，2：加载到缓存，3：呼叫完，4：已冻结', 'type' => 'string', 'example' => '0'], + 'RepeatCount' => ['title' => '重复条数', 'description' => '重复条数', 'type' => 'string', 'example' => '0'], + 'TaskId' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => '27'], + 'RestrictCount' => ['title' => '黑名单条数', 'description' => '黑名单条数', 'type' => 'string', 'example' => '0'], + 'ImportCount' => ['title' => '导入条数', 'description' => '导入条数', 'type' => 'string', 'example' => '3'], + 'Priority' => ['title' => '优先级，默认为0，值越大优先级越高', 'description' => '优先级，默认为0，值越大优先级越高', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建批次时间，格式为： yyyy-MM-dd HH:mm:ss', 'description' => '创建批次时间，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Id' => ['title' => '批次Id', 'description' => '批次Id', 'type' => 'string', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '批次名称', 'description' => '批次名称', 'type' => 'string', 'example' => 'name2'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"TaskId\\": \\"4001112222\\"\\n}","type":"json"}]', - 'title' => '批量发起智能语音机器人外呼任务', - 'summary' => '批量发起智能语音机器人外呼任务，一次任务支持设置1~100个号码。', - 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'- 在智能语音交互通话中，支持使用控制台预设的机器人话术，或在每轮通话中通过回调接口返回业务方设置的回应方式。'."\n" - ."\n" - .'- 此接口用于直接使用控制台预设的机器人话术，发起机器人外呼任务。'."\n" - ."\n" - .'### 前提条件'."\n" - .'- 已实名认证为企业用户，并审核通过了企业资质。'."\n" - .'- 已在[语音服务控制台](https://dyvms.console.aliyun.com/dyvms.htm#/number/normal)上购买了号码。 '."\n" - .'- 已在[话术管理页面](https://dyvms.console.aliyun.com/dyvms.htm#/smart-call/saas/robot/list)添加了话术并通过审核。'."\n" - ."\n" - .'> 请确保在使用该接口前，已充分了解语音服务产品的收费方式和[价格](https://www.aliyun.com/price/product#/vms/detail)。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StartRobotTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取呼叫任务批次列表', + 'summary' => '获取呼叫任务批次列表信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"TaskFileList\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"RepeatCount\\": \\"0\\",\\n \\"TaskId\\": \\"27\\",\\n \\"RestrictCount\\": \\"0\\",\\n \\"ImportCount\\": \\"3\\",\\n \\"Priority\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name2\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudMonitorTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['title' => '外呼任务id', 'description' => '外呼任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。可通过[CreateRobotTask](~~CreateRobotTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '104500****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'RemovedAgentStatisticList' => [ + 'title' => '已移除座席统计详情，仅当 `includeRemovedAgents=1` 时返回', + 'description' => '已移除座席统计详情，仅当 `includeRemovedAgents=1` 时返回', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TodayAnsweredCount' => ['title' => '任务级别 座席今日已接听数', 'description' => '任务级别 座席今日已接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'NoBridgeCount' => ['title' => '座席未接听数', 'description' => '座席未接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'EnterpriseCallLimit' => ['title' => '企业级别 座席单日接听上限，-1代表未配置接听上限', 'description' => '企业级别 座席单日接听上限，-1代表未配置接听上限', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'Name' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => 'name'], + 'AvgBridgeTime' => ['title' => '座席平均通话时长，单位秒数', 'description' => '座席平均通话时长，单位秒数', 'type' => 'string', 'example' => '39'], + 'EnterpriseTodayAnsweredCount' => ['title' => '企业级别 座席今日已接听数', 'description' => '企业级别 座席今日已接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'AgentStatus' => ['title' => '座席当前状态: stateIdle(空闲) statePause(置忙) stateInuse(通话） stateCalling(呼叫中) stateWrapup(整理) 为空代表该当前时间座席在该任务中没有相关状态，如：座席未被使用等', 'description' => '座席当前状态: stateIdle(空闲) statePause(置忙) stateInuse(通话） stateCalling(呼叫中) stateWrapup(整理) 为空代表该当前时间座席在该任务中没有相关状态，如：座席未被使用等', 'type' => 'string', 'example' => 'stateIdle'], + 'AgentAvgIdleTime' => ['title' => '座席平均进线时长,空闲时长/呼叫数', 'description' => '座席平均进线时长,空闲时长/呼叫数', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'BridgeCount' => ['title' => '接听数', 'description' => '接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CalledCount' => ['title' => '呼叫数', 'description' => '呼叫数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'BridgeIn2sRate' => ['title' => '座席自动应答率=(座席接通时间-开始呼叫座席时间)<=2s的通话数/座席接通数', 'description' => '座席自动应答率=(座席接通时间-开始呼叫座席时间)<=2s的通话数/座席接通数', 'type' => 'number', 'format' => 'double', 'example' => '3.55'], + 'CallLimit' => ['title' => '任务级别，座席单日接听上限，-1代表未配置接听上限', 'description' => '任务级别，座席单日接听上限，-1代表未配置接听上限', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'TodayStatistic' => [ + 'title' => '当日任务监控信息', + 'description' => '当日任务监控信息', + 'type' => 'object', + 'properties' => [ + 'CtiLinkTaskProperty' => [ + 'description' => '任务属性', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'description' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'type' => 'string', 'example' => '2'], + 'OverTime' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => '2026-04-20 11:00:00'], + 'StatusDescription' => ['title' => '任务状态描述', 'description' => '任务状态描述', 'type' => 'string', 'example' => '号码呼完'], + 'StartTime' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Id' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12314'], + 'Name' => ['title' => '任务名称 ', 'description' => '任务名称 ', 'type' => 'string', 'example' => 'testTask'], + ], + 'example' => '', + ], + 'AgentCount' => ['title' => '座席数量', 'description' => '座席数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'CalledCount' => ['title' => '已呼叫数量', 'description' => '已呼叫数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'AnswerCount' => ['title' => '应答数量', 'description' => '应答数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'UncalledCount' => ['title' => '未呼叫数量', 'description' => '未呼叫数量', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallAgentCount' => ['title' => '呼叫坐席数', 'description' => '呼叫坐席数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + 'example' => '', + ], + 'Statistic' => [ + 'title' => '任务监控信息', + 'description' => '任务监控信息', + 'type' => 'object', + 'properties' => [ + 'CtiLinkTaskProperty' => [ + 'title' => '任务属性', + 'description' => '任务属性', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'description' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'OverTime' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => '2026-04-20 11:00:00'], + 'StatusDescription' => ['title' => '任务状态描述', 'description' => '任务状态描述', 'type' => 'string', 'example' => '号码呼完'], + 'StartTime' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Id' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12314'], + 'Name' => ['title' => '任务名称 ', 'description' => '任务名称 ', 'type' => 'string', 'example' => 'testTask'], + ], + 'example' => '', + ], + 'AgentCount' => ['title' => '座席数量', 'description' => '座席数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CalledCount' => ['title' => '已呼叫数量', 'description' => '已呼叫数量', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'AnswerCount' => ['title' => '应答数量', 'description' => '应答数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'UncalledCount' => ['title' => '未呼叫数量', 'description' => '未呼叫数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CallAgentCount' => ['title' => '呼叫坐席数', 'description' => '呼叫坐席数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + 'example' => '', + ], + 'AgentStatisticList' => [ + 'title' => '座席统计详情', + 'description' => '座席统计详情', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TodayAnsweredCount' => ['title' => '任务级别 座席今日已接听数', 'description' => '任务级别 座席今日已接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'NoBridgeCount' => ['title' => '座席未接听数', 'description' => '座席未接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'EnterpriseCallLimit' => ['title' => '企业级别 座席单日接听上限，-1代表未配置接听上限', 'description' => '企业级别 座席单日接听上限，-1代表未配置接听上限', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'Name' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => 'name2'], + 'AvgBridgeTime' => ['title' => '座席平均通话时长，单位秒数', 'description' => '座席平均通话时长，单位秒数', 'type' => 'string', 'example' => '116'], + 'EnterpriseTodayAnsweredCount' => ['title' => '企业级别 座席今日已接听数', 'description' => '企业级别 座席今日已接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'AgentStatus' => ['title' => '座席当前状态: stateIdle(空闲) statePause(置忙) stateInuse(通话） stateCalling(呼叫中) stateWrapup(整理) 为空代表该当前时间座席在该任务中没有相关状态，如：座席未被使用等', 'description' => '座席当前状态: stateIdle(空闲) statePause(置忙) stateInuse(通话） stateCalling(呼叫中) stateWrapup(整理) 为空代表该当前时间座席在该任务中没有相关状态，如：座席未被使用等', 'type' => 'string', 'example' => 'stateIdle'], + 'AgentAvgIdleTime' => ['title' => '座席平均进线时长,空闲时长/呼叫数', 'description' => '座席平均进线时长,空闲时长/呼叫数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BridgeCount' => ['title' => '接听数', 'description' => '接听数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CalledCount' => ['title' => '呼叫数', 'description' => '呼叫数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'BridgeIn2sRate' => ['title' => '座席自动应答率=(座席接通时间-开始呼叫座席时间)<=2s的通话数/座席接通数', 'description' => '座席自动应答率=(座席接通时间-开始呼叫座席时间)<=2s的通话数/座席接通数', 'type' => 'number', 'format' => 'double', 'example' => '0.0'], + 'CallLimit' => ['title' => '任务级别，座席单日接听上限，-1代表未配置接听上限', 'description' => '任务级别，座席单日接听上限，-1代表未配置接听上限', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'ChannelInfo' => [ + 'title' => '通道监控信息', + 'description' => '通道监控信息', + 'type' => 'object', + 'properties' => [ + 'BridgedCount' => ['title' => '桥接个数', 'description' => '桥接个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'EnterpriseChannelCount' => ['title' => '企业预测外呼通道数', 'description' => '企业预测外呼通道数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ChannelCount' => ['title' => '任务当前通道数', 'description' => '任务当前通道数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitAgentCount' => ['title' => '等待转座席的个数', 'description' => '等待转座席的个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AnswerCount' => ['title' => '客户接通个数', 'description' => '客户接通个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'IvrCount' => ['title' => '溢出到ivr数', 'description' => '溢出到ivr数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'WaitAnswerCount' => ['title' => '等待客户接听的个数', 'description' => '等待客户接听的个数', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + 'example' => '', + ], + 'AgentInfo' => [ + 'title' => '座席状态统计', + 'description' => '座席状态统计', + 'type' => 'object', + 'properties' => [ + 'WrapupCount' => ['title' => '整理中的座席数', 'description' => '整理中的座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'TotalCount' => ['title' => '座席总数 ', 'description' => '座席总数 ', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'RingingCount' => ['title' => '响铃中的座席数', 'description' => '响铃中的座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'BridgeCount' => ['title' => '通话中的座席数', 'description' => '通话中的座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'OnlineCount' => ['title' => '当前在线座席数', 'description' => '当前在线座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AvailableCount' => ['title' => '可用座席数', 'description' => '可用座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '监控呼叫任务', + 'summary' => '呼叫任务监控。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RemovedAgentStatisticList\\": [\\n {\\n \\"TodayAnsweredCount\\": 3,\\n \\"Cno\\": \\"1111\\",\\n \\"NoBridgeCount\\": 3,\\n \\"EnterpriseCallLimit\\": -1,\\n \\"Name\\": \\"name\\",\\n \\"AvgBridgeTime\\": \\"39\\",\\n \\"EnterpriseTodayAnsweredCount\\": 3,\\n \\"AgentStatus\\": \\"stateIdle\\",\\n \\"AgentAvgIdleTime\\": 13,\\n \\"BridgeCount\\": 3,\\n \\"CalledCount\\": 5,\\n \\"BridgeIn2sRate\\": 3.55,\\n \\"CallLimit\\": -1\\n }\\n ],\\n \\"TodayStatistic\\": {\\n \\"CtiLinkTaskProperty\\": {\\n \\"Status\\": \\"2\\",\\n \\"OverTime\\": \\"2026-04-20 11:00:00\\",\\n \\"StatusDescription\\": \\"号码呼完\\",\\n \\"StartTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 12314,\\n \\"Name\\": \\"testTask\\"\\n },\\n \\"AgentCount\\": 3,\\n \\"CalledCount\\": 3,\\n \\"AnswerCount\\": 3,\\n \\"UncalledCount\\": 0,\\n \\"CallAgentCount\\": 3\\n },\\n \\"Statistic\\": {\\n \\"CtiLinkTaskProperty\\": {\\n \\"Status\\": 2,\\n \\"OverTime\\": \\"2026-04-20 11:00:00\\",\\n \\"StatusDescription\\": \\"号码呼完\\",\\n \\"StartTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Id\\": 12314,\\n \\"Name\\": \\"testTask\\"\\n },\\n \\"AgentCount\\": 2,\\n \\"CalledCount\\": 4,\\n \\"AnswerCount\\": 3,\\n \\"UncalledCount\\": 1,\\n \\"CallAgentCount\\": 3\\n },\\n \\"AgentStatisticList\\": [\\n {\\n \\"TodayAnsweredCount\\": 3,\\n \\"Cno\\": \\"1111\\",\\n \\"NoBridgeCount\\": 0,\\n \\"EnterpriseCallLimit\\": -1,\\n \\"Name\\": \\"name2\\",\\n \\"AvgBridgeTime\\": \\"116\\",\\n \\"EnterpriseTodayAnsweredCount\\": 3,\\n \\"AgentStatus\\": \\"stateIdle\\",\\n \\"AgentAvgIdleTime\\": 0,\\n \\"BridgeCount\\": 0,\\n \\"CalledCount\\": 0,\\n \\"BridgeIn2sRate\\": 0,\\n \\"CallLimit\\": -1\\n }\\n ],\\n \\"ChannelInfo\\": {\\n \\"BridgedCount\\": 0,\\n \\"EnterpriseChannelCount\\": 2,\\n \\"ChannelCount\\": 0,\\n \\"WaitAgentCount\\": 0,\\n \\"AnswerCount\\": 0,\\n \\"IvrCount\\": 0,\\n \\"WaitAnswerCount\\": 0\\n },\\n \\"AgentInfo\\": {\\n \\"WrapupCount\\": 4,\\n \\"TotalCount\\": 2,\\n \\"RingingCount\\": 4,\\n \\"BridgeCount\\": 6,\\n \\"OnlineCount\\": 2,\\n \\"AvailableCount\\": 2\\n }\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudOutboundObClidReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ScheduleTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '定时启动时间。格式为yyyy-MM-dd HH:mm:ss。', - 'type' => 'string', - 'required' => false, - 'example' => '2019-06-14 14:55:23', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '统计类型；说明：统计报表时间类型，1：日报表2：周报表3：月报表4：自定义时间', 'description' => '统计类型；说明：统计报表时间类型，1：日报表2：周报表3：月报表4：自定义时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'StatisticMethod', + 'in' => 'query', + 'schema' => ['title' => '统计方法；说明：0：分时1：分日2：汇总11：中继群组汇总', 'description' => '统计方法；说明：0：分时1：分日2：汇总11：中继群组汇总', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'AreaCodes', + 'in' => 'query', + 'schema' => ['title' => '说明：根据区号查询指定区域的预览外呼被叫号码统计支持按照多个区号进行查询，多个区号之间使用英文逗号","分隔，默认查询账户下所有地区的预览外呼被叫号码统计', 'description' => '说明：根据区号查询指定区域的预览外呼被叫号码统计支持按照多个区号进行查询，多个区号之间使用英文逗号","分隔，默认查询账户下所有地区的预览外呼被叫号码统计', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2017-06-13'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2017-06-13'], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['title' => '统计时段开始时间；取值：0~23,默认值为0时', 'description' => '统计时段开始时间；取值：0~23,默认值为0时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['title' => '统计时段结束时间；取值：0~23,默认值为24时', 'description' => '统计时段结束时间；取值：0~23,默认值为24时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '查询起始位置；取值：大于等于0，默认0', 'description' => '查询起始位置；取值：大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '查询条数；取值：最大不能超过1000，默认10', 'description' => '查询条数；取值：最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功。'."\n" - .'- **false**：失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回的数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClidRate' => ['title' => '号码接听率', 'description' => '号码接听率', 'type' => 'string', 'example' => '20%'], + 'ValidTotalBridgeTime' => ['title' => '有效通话总时长', 'description' => '有效通话总时长', 'type' => 'string', 'example' => '00:00:42'], + 'MaxBridgeTime' => ['title' => '最长通话时长', 'description' => '最长通话时长', 'type' => 'string', 'example' => '00:00:45'], + 'Clid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '01089192349'], + 'TrunkGroupKey' => ['title' => '中继群组代号', 'description' => '中继群组代号', 'type' => 'string', 'example' => '10000'], + 'CallType' => ['description' => '通话类型。', 'type' => 'string', 'example' => '示例值'], + 'PreviewObCustomerRingingCount' => ['title' => '响铃数', 'description' => '响铃数', 'type' => 'integer', 'format' => 'int64', 'example' => '19'], + 'AvgPreviewObWaitTime' => ['title' => '平均等待时长', 'description' => '平均等待时长', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'PreviewObCustomerRingingRate' => ['title' => '响铃率', 'description' => '响铃率', 'type' => 'string', 'example' => '95%'], + 'ValidAvgBridgeTime' => ['title' => '有效通话平均时长', 'description' => '有效通话平均时长', 'type' => 'string', 'example' => '00:00:21'], + 'AnsweredCount' => ['title' => '客户接听数', 'description' => '客户接听数', 'type' => 'string', 'example' => '4'], + 'EnterpriseId' => ['title' => '企业Id', 'description' => '企业Id', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'AvgBridgeTime' => ['title' => '平均通话时长', 'description' => '平均通话时长', 'type' => 'string', 'example' => '00:02:12'], + 'ValidCalls' => ['title' => '有效通话次数', 'description' => '有效通话次数', 'type' => 'string', 'example' => '2'], + 'DateTimeRange' => ['title' => '时间范围', 'description' => '时间范围', 'type' => 'string', 'example' => '2026年4月'], + 'Hour' => ['title' => '小时', 'description' => '小时', 'type' => 'string', 'example' => '0'], + 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'City' => ['title' => '城市', 'description' => '城市', 'type' => 'string', 'example' => '北京'], + 'Province' => ['title' => '省份', 'description' => '省份', 'type' => 'string', 'example' => '北京'], + 'TotalCount' => ['title' => '外呼总数', 'description' => '外呼总数', 'type' => 'string', 'example' => '20'], + 'TotalBridgeTime' => ['title' => '总通话时长', 'description' => '总通话时长', 'type' => 'string', 'example' => '00:08:48'], + 'Day' => ['title' => '报表日期', 'description' => '报表日期', 'type' => 'string', 'example' => '2026-04-20'], + 'CustomerBillMinute' => ['title' => '客户侧计费分钟数', 'description' => '客户侧计费分钟数', 'type' => 'integer', 'format' => 'int64', 'example' => '45'], + 'MinBridgeTime' => ['title' => '最短通话时长', 'description' => '最短通话时长', 'type' => 'string', 'example' => '00:00:03'], + 'RowName' => ['title' => '格式化日期', 'description' => '格式化日期', 'type' => 'string', 'example' => '外显号码[01089192349]'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<StartRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StartRobotTaskResponse>","errorExample":""}]', - 'title' => '启动任务或定时启动任务', - 'summary' => '启动智能语音任务或者定时启动智能语音任务。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '预览外呼主叫号码报表', + 'summary' => '获取预览外呼主叫报表数据。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ClidRate\\": \\"20%\\",\\n \\"ValidTotalBridgeTime\\": \\"00:00:42\\",\\n \\"MaxBridgeTime\\": \\"00:00:45\\",\\n \\"Clid\\": \\"01089192349\\",\\n \\"TrunkGroupKey\\": \\"10000\\",\\n \\"CallType\\": \\"示例值\\",\\n \\"PreviewObCustomerRingingCount\\": 19,\\n \\"AvgPreviewObWaitTime\\": 5,\\n \\"PreviewObCustomerRingingRate\\": \\"95%\\",\\n \\"ValidAvgBridgeTime\\": \\"00:00:21\\",\\n \\"AnsweredCount\\": \\"4\\",\\n \\"EnterpriseId\\": 7000002,\\n \\"AvgBridgeTime\\": \\"00:02:12\\",\\n \\"ValidCalls\\": \\"2\\",\\n \\"DateTimeRange\\": \\"2026年4月\\",\\n \\"Hour\\": \\"0\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\",\\n \\"TotalCount\\": \\"20\\",\\n \\"TotalBridgeTime\\": \\"00:08:48\\",\\n \\"Day\\": \\"2026-04-20\\",\\n \\"CustomerBillMinute\\": 45,\\n \\"MinBridgeTime\\": \\"00:00:03\\",\\n \\"RowName\\": \\"外显号码[01089192349]\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'StopRobotTask' => [ - 'methods' => [ - 'post', - 'get', + 'CloudOutboundPreviewObReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6000001'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '统计类型；说明：统计报表时间类型，1：日报表2：周报表3：月报表4：自定义时间', 'description' => '统计类型；说明：统计报表时间类型，1：日报表2：周报表3：月报表4：自定义时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'StatisticMethod', + 'in' => 'query', + 'schema' => ['title' => '统计方法；说明：0:分时1：分日2：汇总', 'description' => '统计方法；说明：0:分时1：分日2：汇总', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席号；说明：根据座席工号查询指定座席的预览外呼统计支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的预览外呼统计', 'description' => '座席号；说明：根据座席工号查询指定座席的预览外呼统计支持按照多个座席工号进行查询，多个座席工号之间使用英文逗号","分隔，默认查询账户下所有座席的预览外呼统计', 'type' => 'string', 'required' => true, 'example' => '3008'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的开始时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2017-06-13'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'description' => '说明：统计日期的结束时间，格式：yyyy-MM-dd', 'type' => 'string', 'required' => true, 'example' => '2017-06-13'], + ], + [ + 'name' => 'StartHour', + 'in' => 'query', + 'schema' => ['title' => '统计时段开始时间；取值：0~23,默认值为0时', 'description' => '统计时段开始时间；取值：0~23,默认值为0时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'EndHour', + 'in' => 'query', + 'schema' => ['title' => '统计时段结束时间；取值：0~23,默认值为24时', 'description' => '统计时段结束时间；取值：0~23,默认值为24时', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '查询起始位置；取值：大于等于0，默认0', 'description' => '查询起始位置；取值：大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '查询条数；取值：最大不能超过1000，默认10', 'description' => '查询条数；取值：最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalPageCount' => ['description' => '总页数', 'type' => 'string', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '分页大小。', 'type' => 'string', 'example' => '10'], + 'List' => [ + 'description' => '列表。', + 'type' => 'array', + 'items' => [ + 'description' => '报表数据', + 'type' => 'object', + 'properties' => [ + 'ValidTotalBridgeTime' => ['title' => '有效通话总通话时长', 'description' => '有效通话总通话时长', 'type' => 'string', 'example' => '00:00:38'], + 'MaxBridgeTime' => ['title' => '最长通话时长', 'description' => '最长通话时长', 'type' => 'string', 'example' => '00:00:14'], + 'AxbObTotalCount' => ['title' => 'AXB外呼总数', 'description' => 'AXB外呼总数', 'type' => 'string', 'example' => '0'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '3008'], + 'AxbBothAnsweredTime' => ['title' => 'AXB外呼双方接听分钟数', 'description' => 'AXB外呼双方接听分钟数', 'type' => 'string', 'example' => '0'], + 'CustomerRate' => ['title' => '客户接听率', 'description' => '客户接听率', 'type' => 'string', 'example' => '100%'], + 'LandlineBothAnsweredRate' => ['title' => '固话双方接听率 = 固话双方接听数 / 固话外呼总数', 'description' => '固话双方接听率 = 固话双方接听数 / 固话外呼总数', 'type' => 'string', 'example' => '100%'], + 'CustomerAnsweredCount' => ['title' => '客户接听数', 'description' => '客户接听数', 'type' => 'string', 'example' => '3'], + 'ValidAvgBridgeTime' => ['title' => '有效通话平均通话时长', 'description' => '有效通话平均通话时长', 'type' => 'string', 'example' => '00:00:12'], + 'EnterpriseId' => ['title' => '企业Id', 'description' => '企业Id', 'type' => 'string', 'example' => '6000001'], + 'BothAnsweredTime' => ['title' => '双方接听时长', 'description' => '双方接听时长', 'type' => 'string', 'example' => '2'], + 'ValidCalls' => ['title' => '有效通话次数', 'description' => '有效通话次数', 'type' => 'string', 'example' => '3'], + 'AvgBridgeTime' => ['title' => '平均通话时长', 'description' => '平均通话时长', 'type' => 'string', 'example' => '00:00:12'], + 'CallTotalCount' => ['title' => '发起呼叫次数', 'description' => '发起呼叫次数', 'type' => 'string', 'example' => '3'], + 'LandlineBothAnsweredTime' => ['title' => '固话双方接听分钟数', 'description' => '固话双方接听分钟数', 'type' => 'string', 'example' => '0'], + 'AgentAnsweredCount' => ['title' => '座席接听数', 'description' => '座席接听数', 'type' => 'string', 'example' => '3'], + 'AgentName' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'example' => 'name3'], + 'DateTimeRange' => ['title' => '统计周期', 'description' => '统计周期', 'type' => 'string', 'example' => '2017年06月13日'], + 'CallBridgedRate' => ['title' => '呼叫接通率', 'description' => '呼叫接通率', 'type' => 'string', 'example' => '100%'], + 'AxbBothAnsweredRate' => ['title' => 'AXB双方接听率 = AXB双方接听数 / AXB外呼总数', 'description' => 'AXB双方接听率 = AXB双方接听数 / AXB外呼总数', 'type' => 'string', 'example' => '0%'], + 'LandlineBothAnsweredCount' => ['title' => '固话双方接听数', 'description' => '固话双方接听数', 'type' => 'string', 'example' => '3'], + 'AgentRate' => ['title' => '座席接听率', 'description' => '座席接听率', 'type' => 'string', 'example' => '100%'], + 'TotalCount' => ['title' => '外呼总数', 'description' => '外呼总数', 'type' => 'string', 'example' => '3'], + 'InterceptionCount' => ['title' => '拦截次数', 'description' => '拦截次数', 'type' => 'string', 'example' => '0'], + 'TotalBridgeTime' => ['title' => '总通话时长', 'description' => '总通话时长', 'type' => 'string', 'example' => '00:00:38'], + 'AxbBothAnsweredCount' => ['title' => 'AXB双方接听数', 'description' => 'AXB双方接听数', 'type' => 'string', 'example' => '0'], + 'InterceptionRate' => ['title' => '拦截率', 'description' => '拦截率', 'type' => 'string', 'example' => '0%'], + 'VadRate' => ['title' => '通话占比', 'description' => '通话占比', 'type' => 'string', 'example' => '0%'], + 'LandlineObTotalCount' => ['title' => '固话外呼总数', 'description' => '固话外呼总数', 'type' => 'string', 'example' => '0'], + 'BothAnsweredCount' => ['title' => '双方接听数', 'description' => '双方接听数', 'type' => 'string', 'example' => '3'], + 'MinBridgeTime' => ['title' => '最短通话时长', 'description' => '最短通话时长', 'type' => 'string', 'example' => '00:00:11'], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取预览外呼报表', + 'summary' => '获取预览外呼报表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalPageCount\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"List\\": [\\n {\\n \\"ValidTotalBridgeTime\\": \\"00:00:38\\",\\n \\"MaxBridgeTime\\": \\"00:00:14\\",\\n \\"AxbObTotalCount\\": \\"0\\",\\n \\"Cno\\": \\"3008\\",\\n \\"AxbBothAnsweredTime\\": \\"0\\",\\n \\"CustomerRate\\": \\"100%\\",\\n \\"LandlineBothAnsweredRate\\": \\"100%\\",\\n \\"CustomerAnsweredCount\\": \\"3\\",\\n \\"ValidAvgBridgeTime\\": \\"00:00:12\\",\\n \\"EnterpriseId\\": \\"6000001\\",\\n \\"BothAnsweredTime\\": \\"2\\",\\n \\"ValidCalls\\": \\"3\\",\\n \\"AvgBridgeTime\\": \\"00:00:12\\",\\n \\"CallTotalCount\\": \\"3\\",\\n \\"LandlineBothAnsweredTime\\": \\"0\\",\\n \\"AgentAnsweredCount\\": \\"3\\",\\n \\"AgentName\\": \\"name3\\",\\n \\"DateTimeRange\\": \\"2017年06月13日\\",\\n \\"CallBridgedRate\\": \\"100%\\",\\n \\"AxbBothAnsweredRate\\": \\"0%\\",\\n \\"LandlineBothAnsweredCount\\": \\"3\\",\\n \\"AgentRate\\": \\"100%\\",\\n \\"TotalCount\\": \\"3\\",\\n \\"InterceptionCount\\": \\"0\\",\\n \\"TotalBridgeTime\\": \\"00:00:38\\",\\n \\"AxbBothAnsweredCount\\": \\"0\\",\\n \\"InterceptionRate\\": \\"0%\\",\\n \\"VadRate\\": \\"0%\\",\\n \\"LandlineObTotalCount\\": \\"0\\",\\n \\"BothAnsweredCount\\": \\"3\\",\\n \\"MinBridgeTime\\": \\"00:00:11\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudPauseTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['title' => '外呼任务id', 'description' => '外呼任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '15'], + ], + [ + 'name' => 'PauseDuration', + 'in' => 'query', + 'schema' => ['title' => '暂停时长；默认0', 'description' => '暂停时长；默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '响应消息', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功。'."\n" - .'- **false**：失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<StopRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StopRobotTaskResponse>","errorExample":""}]', - 'title' => '暂停智能语音任务', - 'summary' => '暂停开始执行后的智能语音任务。', - 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'- 暂停任务后，您可以调用[StartRobotTask](~~StartRobotTask~~)接口启动任务。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '呼叫任务暂停', + 'summary' => '通过此接口暂停呼叫任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'CancelOrderRobotTask' => [ - 'methods' => [ - 'post', - 'get', + 'CloudPreviewoutcall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号；3-10位数字', 'description' => '座席工号；3-10位数字', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['title' => '需要进行呼叫的客户方电话号码，固话带区号，手机不加0。 当开启号码隐藏设置时，可从弹屏事件中获取customerNumberKey的值，进行外呼；[加密外呼](../字段定义/接口部分/加密外呼号码加密规则.md)；如果是加密的号码，需要URLEncode后传入；当外呼相关配置-支持分机号外呼开启后，此字段可支持传手机号-分机号格式', 'description' => '需要进行呼叫的客户方电话号码，固话带区号，手机不加0。 当开启号码隐藏设置时，可从弹屏事件中获取customerNumberKey的值，进行外呼；[加密外呼](../字段定义/接口部分/加密外呼号码加密规则.md)；如果是加密的号码，需要URLEncode后传入；当外呼相关配置-支持分机号外呼开启后，此字段可支持传手机号-分机号格式', 'type' => 'string', 'required' => true, 'example' => '1774821736'], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['title' => '呼叫座席侧超时时间；取值范围 5<=timeout<=60，默认30(单位:s)', 'description' => '呼叫座席侧超时时间；取值范围 5<=timeout<=60，默认30(单位:s)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16'], + ], + [ + 'name' => 'DialTelTimeout', + 'in' => 'query', + 'schema' => ['title' => '呼叫客户侧超时时间；取值范围 5<=dialTelTimeout<=60，默认45(单位:s)', 'description' => '呼叫客户侧超时时间；取值范围 5<=dialTelTimeout<=60，默认45(单位:s)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26'], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['title' => '通道变量可以在以下场景中使用：1. 事件推送，作为推送字段使用2. 通话记录中，将字段存储在自定义字段3. 通过SIP-Header方式将字段传到呼叫的下游链路格式如: [{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]name：变量名称value：变量值type：变量类型，1.普通变量 2.PJSIP_HEADER变量（用于将变量通过SIP-Header方式传到客户侧，最多支持5个）', 'description' => '通道变量可以在以下场景中使用：1. 事件推送，作为推送字段使用2. 通话记录中，将字段存储在自定义字段3. 通过SIP-Header方式将字段传到呼叫的下游链路格式如: [{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]name：变量名称value：变量值type：变量类型，1.普通变量 2.PJSIP_HEADER变量（用于将变量通过SIP-Header方式传到客户侧，最多支持5个）', 'type' => 'string', 'required' => false, 'example' => '[{"name":"mainUniqueId","value":"cdr_main_unique_id","type":"2"},{"name":"callType","value":"cdr_call_type","type":"2"}]'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '请求唯一id；取值：如果没有传入值则系统会生产。如果是加密的号码，需要URLEncode后传入', 'description' => '请求唯一id；取值：如果没有传入值则系统会生产。如果是加密的号码，需要URLEncode后传入', 'type' => 'string', 'required' => false, 'example' => 'req1234567'], + ], + [ + 'name' => 'BackupTels', + 'in' => 'query', + 'schema' => ['title' => '备用外呼号码；tel没呼通时呼叫备用号码，最多支持5个号码，多个之间用逗号分隔', 'description' => '备用外呼号码；tel没呼通时呼叫备用号码，最多支持5个号码，多个之间用逗号分隔', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'IsInvestigation', + 'in' => 'query', + 'schema' => ['title' => '是否满意度调查；0.不进行满意度调查 1.进行满意度调查，默认：取企业配置', 'description' => '是否满意度调查；0.不进行满意度调查 1.进行满意度调查，默认：取企业配置', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CdrIsAsr', + 'in' => 'query', + 'schema' => ['title' => '此次通话录音是否进行ASR转写；0.不进行 1.进行 默认：1', 'description' => '此次通话录音是否进行ASR转写；0.不进行 1.进行 默认：1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CrnId', + 'in' => 'query', + 'schema' => ['title' => '外显导航标识', 'description' => '外显导航标识', 'type' => 'string', 'required' => false, 'example' => '12333'], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['title' => '可传入企业中继号码或设置好的客户侧外显号码', 'description' => '可传入企业中继号码或设置好的客户侧外显号码', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'ObClidAreaCode', + 'in' => 'query', + 'schema' => ['title' => '指定外显区号；传入区号，在指定区号下外显号码；如果obClid和obClidAreaCode都传的情况下，按照obClid外显', 'description' => '指定外显区号；传入区号，在指定区号下外显号码；如果obClid和obClidAreaCode都传的情况下，按照obClid外显', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'ObClidGroup', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码组；使用clidGroup需要账号支持按标识路由，使用此参数时clid参数无效', 'description' => '客户侧外显号码组；使用clidGroup需要账号支持按标识路由，使用此参数时clid参数无效', 'type' => 'string', 'required' => false, 'example' => '333'], + ], + [ + 'name' => 'ClidList', + 'in' => 'query', + 'schema' => ['title' => '外显号码集合, 格式如: [{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}] clid：外显号码（String类型）（必填）priority：优先级（Integer类型）（非必填） 特别说明： 一次呼叫最多允许传10个指定号码；若指定了号码优先级，要求所有传入的号码都必传', 'description' => '外显号码集合, 格式如: [{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}] clid：外显号码（String类型）（必填）priority：优先级（Integer类型）（非必填） 特别说明： 一次呼叫最多允许传10个指定号码；若指定了号码优先级，要求所有传入的号码都必传', 'type' => 'string', 'required' => false, 'example' => ' [{"clid":"1708587xxxx","priority":1},{"clid":"1304412xxxx","priority":2},{"clid":"0107990xxxx","priority":3}]'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席外呼', + 'summary' => '当座席在线时，通过此接口进行呼叫。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryAgent' => [ + 'summary' => '查询座席详细信息列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['title' => '队列号；当qno不为空时，查询指定队列的所有座席记录', 'description' => '队列号；当qno不为空时，查询指定队列的所有座席记录', 'type' => 'string', 'required' => false, 'example' => '333'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '多个座席号以英文逗号分隔 最多支持500个座席', 'description' => '多个座席号以英文逗号分隔 最多支持500个座席', 'type' => 'string', 'required' => false, 'example' => '1111,2222'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始；正整数，大于等于0，默认0', 'description' => '从第几条开始；正整数，大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '查询条数；正整数，大于0，最大不能超过1000，默认10', 'description' => '查询条数；正整数，大于0，最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['title' => '是否启用；正整数，只能是0或者1，0是停用，1是启用', 'description' => '是否启用；正整数，只能是0或者1，0是停用，1是启用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '是否在线；正整数，只能是0或者1，0是离线，1是在线', 'description' => '是否在线；正整数，只能是0或者1，0是离线，1是在线', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方式,按照创建时间排序；0正序 1倒序', 'description' => '排序方式,按照创建时间排序；0正序 1倒序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'WebrtcUrlType', 'in' => 'query', + 'schema' => ['title' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '创建时间起始时间点；取值说明："2019-10-11 00:00:00"', 'description' => '创建时间起始时间点；取值说明："2019-10-11 00:00:00"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '创建时间终止时间点；取值说明："2019-10-11 23:59:59"', 'description' => '创建时间终止时间点；取值说明："2019-10-11 23:59:59"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 12:00:00'], + ], + [ + 'name' => 'ReturnQueue', + 'in' => 'query', + 'schema' => ['title' => '是否返回绑定座席的队列信息；0:不返回 1:需要返回 默认值:1', 'description' => '是否返回绑定座席的队列信息；0:不返回 1:需要返回 默认值:1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '通过座席名称检索；取值说明：前后缀模糊匹配', 'description' => '通过座席名称检索；取值说明：前后缀模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'name'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '通过座席备注信息检索；取值说明：前缀模糊匹配', 'description' => '通过座席备注信息检索；取值说明：前缀模糊匹配', 'type' => 'string', 'required' => false, 'example' => 'comment1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。可以通过[CreateRobotTask](~~393531~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'Agents' => [ + 'title' => '座席列表数组', + 'description' => '座席列表数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'title' => '座席信息', + 'description' => '座席信息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '座席状态，0:离线，1：在线', 'description' => '座席状态，0:离线，1：在线', 'type' => 'string', 'example' => '1'], + 'IsQualityCheck' => ['description' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'type' => 'string', 'example' => '1'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '0'], + 'ObClid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '41008502'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录用，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'BindTelType' => ['title' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'description' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'type' => 'string', 'example' => '1'], + 'Wrapup' => ['title' => '整理时间，秒数，默认10秒', 'description' => '整理时间，秒数，默认10秒', 'type' => 'string', 'example' => '10'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'example' => 'name1'], + 'IsAsr' => ['title' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'type' => 'string', 'example' => '1'], + 'AgentType' => ['title' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'description' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'type' => 'string', 'example' => '1'], + 'Active' => ['title' => '是否启用，0：停用，1：启用，默认启用', 'description' => '是否启用，0：停用，1：启用，默认启用', 'type' => 'string', 'example' => '1'], + 'ObClidType' => ['title' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'description' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'type' => 'string', 'example' => '1'], + 'WebrtcUrlType' => ['title' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'string', 'example' => '0'], + 'AreaCode' => ['title' => '区号格式', 'description' => '区号格式', 'type' => 'string', 'example' => '010'], + 'BindTel' => ['title' => '座席绑定电话', 'description' => '座席绑定电话', 'type' => 'string', 'example' => '41008502'], + 'Id' => ['title' => '座席id', 'description' => '座席id', 'type' => 'string', 'example' => '133'], + 'Power' => ['title' => '1：班长席，0：普通座席，默认普通座席', 'description' => '1：班长席，0：普通座席，默认普通座席', 'type' => 'string', 'example' => '1'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], + ], + 'example' => '', + ], + 'QueueList' => [ + 'title' => '座席所属队列信息', + 'description' => '座席所属队列信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServiceLevel' => ['title' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'description' => '服务水平秒数，低于此时间内接听的认为是高服务水平', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'AnnounceSound' => ['title' => '播报固定语音 0关闭 1打开', 'description' => '播报固定语音 0关闭 1打开', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'WrapupTime' => ['title' => '整理时间，取值范围3-3600秒', 'description' => '整理时间，取值范围3-3600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'MaxLen' => ['title' => '最大等待数，设置范围0-999，0表示不做任何限制', 'description' => '最大等待数，设置范围0-999，0表示不做任何限制', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Description' => ['title' => '队列名', 'description' => '队列名', 'type' => 'string', 'example' => 'queue_name'], + 'AnnouncePosition' => ['title' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'description' => '位置播报 0关闭 1大于announce_position_param时播放 2小于等于announce_position_param时播放', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AnnounceSoundFile' => ['title' => '固定语音文件', 'description' => '固定语音文件', 'type' => 'string', 'example' => 'voice_filexxxxx'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'QueueTimeout' => ['title' => '队列超时时间，取值范围5-600秒，默认600秒', 'description' => '队列超时时间，取值范围5-600秒，默认600秒', 'type' => 'integer', 'format' => 'int64', 'example' => '600'], + 'AnnounceSoundFrequency' => ['title' => '播放固定语音周期，秒数', 'description' => '播放固定语音周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '17'], + 'AnnouncePositionYouarenext' => ['title' => '是否播报\'您是下一位\',0关闭，1开启', 'description' => '是否播报\'您是下一位\',0关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AnnouncePositionParam' => ['title' => '多余少余n个时播报，必须大于等于2', 'description' => '多余少余n个时播报，必须大于等于2', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'MemberTimeout' => ['title' => '座席超时时间，取值范围20-60秒，默认25秒', 'description' => '座席超时时间，取值范围20-60秒，默认25秒', 'type' => 'integer', 'format' => 'int64', 'example' => '25'], + 'Weight' => ['title' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'description' => '队列优先级，取值范围1-10，数值越高，优先级越高', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'JoinEmpty' => ['title' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'description' => '队列中为空时是否可以join，取值：1：置忙 2：通话中 4：振铃 8：无效 16：整理', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + 'Qno' => ['title' => '队列号', 'description' => '队列号', 'type' => 'string', 'example' => '322'], + 'MusicClass' => ['title' => '等待语音class', 'description' => '等待语音class', 'type' => 'string', 'example' => 'class1'], + 'Strategy' => ['title' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'description' => '呼叫策略：rrordered:技能优先 rrmemory:轮选 fewestcalls:平均 random:随机 linear:顺序 leastrecent:最长空闲时间', 'type' => 'string', 'example' => 'rrordered'], + 'Id' => ['title' => '队列id', 'description' => '队列id', 'type' => 'integer', 'format' => 'int64', 'example' => '76'], + 'Retry' => ['title' => '座席超时无应答,呼叫下一座席的延迟秒数', 'description' => '座席超时无应答,呼叫下一座席的延迟秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'SayAgentno' => ['title' => '语音报号，true:播报，false:不播报', 'description' => '语音报号，true:播报，false:不播报', 'type' => 'boolean', 'example' => 'true'], + 'VipSupport' => ['title' => '是否支持vip，1:支持，0:不支持', 'description' => '是否支持vip，1:支持，0:不支持', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AnnouncePositionFrequency' => ['title' => '位置播报周期，秒数', 'description' => '位置播报周期，秒数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席详细信息列表获取', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Total\\": 30,\\n \\"Agents\\": [\\n {\\n \\"Agent\\": {\\n \\"Status\\": \\"1\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"0\\",\\n \\"ObClid\\": \\"41008502\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"10\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"IsAsr\\": \\"1\\",\\n \\"AgentType\\": \\"1\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"0\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"BindTel\\": \\"41008502\\",\\n \\"Id\\": \\"133\\",\\n \\"Power\\": \\"1\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"QueueList\\": [\\n {\\n \\"ServiceLevel\\": 5,\\n \\"AnnounceSound\\": 1,\\n \\"WrapupTime\\": 30,\\n \\"MaxLen\\": 0,\\n \\"Description\\": \\"queue_name\\",\\n \\"AnnouncePosition\\": 1,\\n \\"AnnounceSoundFile\\": \\"voice_filexxxxx\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"QueueTimeout\\": 600,\\n \\"AnnounceSoundFrequency\\": 17,\\n \\"AnnouncePositionYouarenext\\": 1,\\n \\"AnnouncePositionParam\\": 4,\\n \\"MemberTimeout\\": 25,\\n \\"Weight\\": 10,\\n \\"JoinEmpty\\": 1,\\n \\"EnterpriseId\\": 7000002,\\n \\"Qno\\": \\"322\\",\\n \\"MusicClass\\": \\"class1\\",\\n \\"Strategy\\": \\"rrordered\\",\\n \\"Id\\": 76,\\n \\"Retry\\": 20,\\n \\"SayAgentno\\": true,\\n \\"VipSupport\\": 1,\\n \\"AnnouncePositionFrequency\\": 10\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryAgentCnoAndName' => [ + 'summary' => '获取所有座席工号和名称消息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席号之间用,分隔 例cnos=2000,20001 最多支持1000个座席', 'description' => '座席号之间用,分隔 例cnos=2000,20001 最多支持1000个座席', 'type' => 'string', 'required' => false, 'example' => '2000,20001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], + 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功。'."\n" - .'- **false**：失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'description' => '座席工号名称列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Cno' => ['title' => '坐席工号', 'description' => '坐席工号', 'type' => 'string', 'example' => '2000'], + 'Name' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => '李四'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelOrderRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</CancelOrderRobotTaskResponse>","errorExample":""}]', - 'title' => '取消智能语音任务', - 'summary' => '取消还未启动的定时智能语音任务。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席工号名称列表获取', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Cno\\": \\"2000\\",\\n \\"Name\\": \\"李四\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'CancelRobotTask' => [ - 'methods' => [ - 'post', - 'get', + 'CloudQueryAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '结果信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['title' => '外呼组名称', 'description' => '外呼组名称', 'type' => 'string', 'example' => 'name1'], + 'Comment' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'description'], + 'Type' => ['title' => '外呼组类型 1：外呼总组 2：外呼组', 'description' => '外呼组类型 1：外呼总组 2：外呼组', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'Gno' => ['title' => '外呼组编号', 'description' => '外呼组编号', 'type' => 'string', 'example' => '233'], + 'Id' => ['title' => '外呼组id', 'description' => '外呼组id', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席外呼组', + 'summary' => '查询座席所在外呼组的信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"name1\\",\\n \\"Comment\\": \\"description\\",\\n \\"Type\\": 2,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"Gno\\": \\"233\\",\\n \\"Id\\": 33,\\n \\"EnterpriseId\\": 7000002\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryAgentSkill' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cnos', 'in' => 'query', + 'schema' => ['title' => '座席工号，可传多个，中间以英文逗号分割', 'description' => '座席工号，可传多个，中间以英文逗号分割', 'type' => 'string', 'required' => true, 'example' => '111,222'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1045001', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '座席技能列表', + 'description' => '座席技能列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillName' => ['title' => '技能名称', 'description' => '技能名称', 'type' => 'string', 'example' => 'skillname'], + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'integer', 'format' => 'int64', 'example' => '79'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'AgentId' => ['title' => '座席id', 'description' => '座席id', 'type' => 'integer', 'format' => 'int64', 'example' => '64'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'integer', 'format' => 'int64', 'example' => '7000002'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席技能', + 'summary' => '通过座席工号查询座席技能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"SkillName\\": \\"skillname\\",\\n \\"SkillLevel\\": 7,\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"SkillId\\": 79,\\n \\"Id\\": 99,\\n \\"AgentId\\": 64,\\n \\"EnterpriseId\\": 7000002\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryIbCdr' => [ + 'summary' => '通过本接口，可以根据条件查询来电通话记录。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'description' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '呼叫结果；参数说明： 1:座席接听 2:已呼叫座席，座席未接听 3:系统接听 4:系统未接听-IVR配置错误 5:系统未接听-停机 6:系统未接听-欠费 7:系统未接听-黑名单 8:系统未接听-未注册 9:系统未接听-彩铃 11:系统未接听-呼叫超出营帐中设置的最大限制 12:系统未接听-客户呼入系统后在系统未应答前挂机 13:其他错误 14:未进入队列 15:队列中放弃 16:队列中超时溢出 17:队列中无座席溢出 18:无座席未进入队列 19:队列满未进入队列', 'description' => '呼叫结果；参数说明： 1:座席接听 2:已呼叫座席，座席未接听 3:系统接听 4:系统未接听-IVR配置错误 5:系统未接听-停机 6:系统未接听-欠费 7:系统未接听-黑名单 8:系统未接听-未注册 9:系统未接听-彩铃 11:系统未接听-呼叫超出营帐中设置的最大限制 12:系统未接听-客户呼入系统后在系统未应答前挂机 13:其他错误 14:未进入队列 15:队列中放弃 16:队列中超时溢出 17:队列中无座席溢出 18:无座席未进入队列 19:队列满未进入队列', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'description' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'description' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'description' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'description' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'description' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775030413'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始取；大于等于0，默认0', 'description' => '从第几条开始取；大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey'], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配， 构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue'], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['title' => '客户号码', 'description' => '客户号码', 'type' => 'string', 'required' => false, 'example' => '17750247753'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号,此字段支持传入多个座席工号，使用英文半角逗号隔开', 'description' => '座席工号,此字段支持传入多个座席工号，使用英文半角逗号隔开', 'type' => 'string', 'required' => false, 'example' => '1111'], + ], + [ + 'name' => 'Qno', + 'in' => 'query', + 'schema' => ['title' => '队列号 参数说明：-1: 未进入队列', 'description' => '队列号 参数说明：-1: 未进入队列', 'type' => 'string', 'required' => false, 'example' => '566'], + ], + [ + 'name' => 'LeaveQueueCode', + 'in' => 'query', + 'schema' => ['title' => '离开队列原因 参数说明： 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出', 'description' => '离开队列原因 参数说明： 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'JoinQueueCode', + 'in' => 'query', + 'schema' => ['title' => '未进入队列原因 参数说明： 4: 无座席未进入队列 , 3: 队列满未进入队列', 'description' => '未进入队列原因 参数说明： 4: 无座席未进入队列 , 3: 队列满未进入队列', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'CalleeNumber', + 'in' => 'query', + 'schema' => ['title' => '座席号码', 'description' => '座席号码', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'Hotline', + 'in' => 'query', + 'schema' => ['title' => '热线号码', 'description' => '热线号码', 'type' => 'string', 'required' => false, 'example' => '10003221'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'], + 'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功。'."\n" - .'- **false**：失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '来电通话记录数组', + 'description' => '来电通话记录数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NumberTrunk' => ['title' => '中继号码', 'description' => '中继号码', 'type' => 'string', 'example' => '89193631'], + 'CustomerProvince' => ['title' => '客户号码归属省份，如 北京', 'description' => '客户号码归属省份，如 北京', 'type' => 'string', 'example' => '北京'], + 'EndTime' => ['title' => '电话结束时间，时间戳，精确到s，如1480904471', 'description' => '电话结束时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'Cno' => ['title' => '座席工号，如2000', 'description' => '座席工号，如2000', 'type' => 'string', 'example' => '1111'], + 'UserField' => ['title' => '通话记录自定义字段，json格式', 'description' => '通话记录自定义字段，json格式', 'type' => 'object', 'example' => '{}'], + 'CallType' => ['title' => '呼叫类型 呼入', 'description' => '呼叫类型 呼入', 'type' => 'string', 'example' => '呼入'], + 'AnswerTime' => ['title' => '系统接听时间，时间戳，精确到s，如1480904471', 'description' => '系统接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'StatusCode' => ['title' => 'status对应的状态码', 'description' => 'status对应的状态码', 'type' => 'string', 'example' => '3'], + 'EndReason' => ['title' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'description' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'type' => 'string', 'example' => '1000'], + 'Qno' => ['title' => '队列号，如1000', 'description' => '队列号，如1000', 'type' => 'string', 'example' => '1000'], + 'RecordFile' => [ + 'title' => '通话记录录音数组，json格式', + 'description' => '通话记录录音数组，json格式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['title' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'description' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Type' => ['title' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'description' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'type' => 'string', 'example' => 'record'], + 'File' => ['title' => '录音文件名', 'description' => '录音文件名', 'type' => 'string', 'example' => 'name3'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'CustomerNumber' => ['title' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984', 'description' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984', 'type' => 'string', 'example' => '18701051984'], + 'AgentName' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => 'name1'], + 'Hotline' => ['title' => '热线号码', 'description' => '热线号码', 'type' => 'string', 'example' => '89193631'], + 'IvrName' => ['title' => 'IVR名称，默认自定义', 'description' => 'IVR名称，默认自定义', 'type' => 'string', 'example' => 'ivrname'], + 'Status' => ['title' => '外呼结果， 如人工接听', 'description' => '外呼结果， 如人工接听', 'type' => 'string', 'example' => '人工接听'], + 'UniqueId' => ['title' => '电话唯一标识', 'description' => '电话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'NumberTrunkAreaCode' => ['title' => '中继号码区号', 'description' => '中继号码区号', 'type' => 'string', 'example' => '010'], + 'CustomerCity' => ['title' => '客户号码归属城市,北京', 'description' => '客户号码归属城市,北京', 'type' => 'string', 'example' => '北京'], + 'StartTime' => ['title' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'description' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'CustomerAreaCode' => ['title' => '客户号码区号', 'description' => '客户号码区号', 'type' => 'string', 'example' => '010'], + 'CalleeNumber' => ['title' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'description' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'type' => 'string', 'example' => '0104100596'], + 'TotalDuration' => ['title' => '总通话时长秒数，单位是s', 'description' => '总通话时长秒数，单位是s', 'type' => 'string', 'example' => '133'], + 'BridgeDuration' => ['title' => '服务处理时长秒数，单位是s', 'description' => '服务处理时长秒数，单位是s', 'type' => 'string', 'example' => '10'], + 'BridgeTime' => ['title' => '座席接听时间，时间戳，精确到s，如1480904471', 'description' => '座席接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'LeaveQueueCode' => ['title' => '离开队列原因 参数说明：-1:该字段没值, 1:呼转座席接听 , 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出', 'description' => '离开队列原因 参数说明：-1:该字段没值, 1:呼转座席接听 , 2: 队列中放弃 , 3: 队列中超时溢出 , 4: 队列中无座席溢出', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', - 'title' => '终止智能语音任务', - 'summary' => '终止智能语音任务。', - 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'- 仅可终止进行中的任务，任务终止后不能再恢复。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取来电通话记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"NumberTrunk\\": \\"89193631\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Cno\\": \\"1111\\",\\n \\"UserField\\": {},\\n \\"CallType\\": \\"呼入\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"AgentName\\": \\"name1\\",\\n \\"Hotline\\": \\"89193631\\",\\n \\"IvrName\\": \\"ivrname\\",\\n \\"Status\\": \\"人工接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"NumberTrunkAreaCode\\": \\"010\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"CustomerAreaCode\\": \\"010\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"133\\",\\n \\"BridgeDuration\\": \\"10\\",\\n \\"BridgeTime\\": \\"1775024775\\",\\n \\"LeaveQueueCode\\": -1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'DeleteRobotTask' => [ - 'methods' => [ - 'post', - 'get', + 'CloudQueryObCdr' => [ + 'summary' => '根据条件查询座席外呼通话记录。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'description' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'description' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'type' => 'string', 'required' => false, 'example' => 'req_uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => ['title' => '呼叫类型；为空表示全部，可选值为：4:预览外呼 6:主叫外呼 9:内部呼叫', 'description' => '呼叫类型；为空表示全部，可选值为：4:预览外呼 6:主叫外呼 9:内部呼叫', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '呼叫结果；参数说明：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。', 'description' => '呼叫结果；参数说明：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '33 '], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'description' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'description' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'description' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'description' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'description' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775030413'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始取；大于等于0，默认0', 'description' => '从第几条开始取；大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '{"userFieldkey":"userFieldvalue"}'], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '{"userFieldkey":"userFieldvalue"}'], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['title' => '客户号码，支持一个或多个客户号码查询，多个客户号码以英文逗号隔开，一次最多支持100个。不支持模糊匹配。', 'description' => '客户号码，支持一个或多个客户号码查询，多个客户号码以英文逗号隔开，一次最多支持100个。不支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => '13322223333'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号，单个座席工号3-10位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持100个。不支持模糊匹配。', 'description' => '座席工号，单个座席工号3-10位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持100个。不支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => '1111'], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['title' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'description' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => '455'], + ], + [ + 'name' => 'AgentNumber', + 'in' => 'query', + 'schema' => ['title' => '座席号码', 'description' => '座席号码', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'required' => false, 'example' => 'name3'], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码过滤条件', 'description' => '客户侧外显号码过滤条件', 'type' => 'string', 'required' => false, 'example' => '4100'], + ], + [ + 'name' => 'LeftDisplayNumber', + 'in' => 'query', + 'schema' => ['title' => '客户侧真实外显号码过滤条件，当使用虚拟号进行AXB外呼且开关打开时，实际过滤的客户侧真实外显号码是虚拟号', 'description' => '客户侧真实外显号码过滤条件，当使用虚拟号进行AXB外呼且开关打开时，实际过滤的客户侧真实外显号码是虚拟号', 'type' => 'string', 'required' => false, 'example' => '2000'], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['title' => '排序方式；取值说明：0: 按照记录产生的时序顺序排序，1：按照记录产生的时序逆序排序，2: 按照结束时间的时序顺序排序，3：按照结束时间的时序逆序排序', 'description' => '排序方式；取值说明：0: 按照记录产生的时序顺序排序，1：按照记录产生的时序逆序排序，2: 按照结束时间的时序顺序排序，3：按照结束时间的时序逆序排序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'ReturnCount', + 'in' => 'query', + 'schema' => ['title' => '是否返回总条数；取值说明：0: 不返回，1：返回，不传默认为1', 'description' => '是否返回总条数；取值说明：0: 不返回，1：返回，不传默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'DownGrade', + 'in' => 'query', + 'schema' => ['title' => '是否呼叫降级；0-否, 1-是', 'description' => '是否呼叫降级；0-否, 1-是', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['title' => '真人接听；取值说明：1-是、0-否', 'description' => '真人接听；取值说明：1-是、0-否', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '座席外呼通话记录数组', + 'description' => '座席外呼通话记录数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['title' => '真人接听时间，时间戳，精确到s，如1480904471', 'description' => '真人接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'CustomerProvince' => ['title' => '客户号码归属省份，如 北京', 'description' => '客户号码归属省份，如 北京', 'type' => 'string', 'example' => '北京'], + 'DisplayNumber' => ['title' => '座席侧真实外显号码，当使用AXB场景进行外呼时，座席侧真实外显号码为虚拟号', 'description' => '座席侧真实外显号码，当使用AXB场景进行外呼时，座席侧真实外显号码为虚拟号', 'type' => 'string', 'example' => '41008502'], + 'TaskId' => ['title' => '座席自动外呼任务id', 'description' => '座席自动外呼任务id', 'type' => 'string', 'example' => '333'], + 'EndTime' => ['title' => '电话结束时间，时间戳，精确到s，如1480904471', 'description' => '电话结束时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024875'], + 'Clid' => ['title' => '客户侧外显号码，当使用虚拟号进行AXB外呼且开关打开时，实际返回的客户侧外显号码是虚拟号', 'description' => '客户侧外显号码，当使用虚拟号进行AXB外呼且开关打开时，实际返回的客户侧外显号码是虚拟号', 'type' => 'string', 'example' => '41008502'], + 'Cno' => ['title' => '座席工号，如2000', 'description' => '座席工号，如2000', 'type' => 'string', 'example' => '2000'."\n"], + 'TrunkGroupKey' => ['title' => '中继群组代号', 'description' => '中继群组代号', 'type' => 'string', 'example' => '30020'], + 'TsiFileFormat' => ['title' => '彩铃文件类型', 'description' => '彩铃文件类型', 'type' => 'string', 'example' => 'mp3'], + 'UserField' => ['title' => '通话记录自定义字段，json格式', 'description' => '通话记录自定义字段，json格式', 'type' => 'object', 'example' => '{}'], + 'CallType' => ['title' => '呼叫类型：4、预览外呼; 6、主叫外呼', 'description' => '呼叫类型：4、预览外呼; 6、主叫外呼', 'type' => 'string', 'example' => '4'], + 'Gno' => ['description' => '座席外呼组号', 'type' => 'string', 'example' => '133'], + 'AnswerTime' => ['title' => '座席接听时间，时间戳，精确到s，如1480904471', 'description' => '座席接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'RequestUniqueId' => ['title' => '请求唯一id', 'description' => '请求唯一id', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'StatusCode' => ['description' => '呼叫结果码', 'type' => 'string', 'example' => '33'], + 'WaitDuration' => ['title' => '客户等待时长秒数，单位是s', 'description' => '客户等待时长秒数，单位是s', 'type' => 'string', 'example' => '5'], + 'AgentClid' => ['title' => '座席侧外显号码', 'description' => '座席侧外显号码', 'type' => 'string', 'example' => '02138276106'], + 'HangupReason' => ['description' => '挂断原因', 'type' => 'string', 'example' => '0'], + 'EndReason' => ['title' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'description' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'type' => 'string', 'example' => '1000'], + 'VadOut' => ['title' => '通话质量百分比,数据是0-100之间，out方向说话占用的百分比', 'description' => '通话质量百分比,数据是0-100之间，out方向说话占用的百分比', 'type' => 'string', 'example' => '70'], + 'RecordFile' => [ + 'title' => '通话记录录音数组，json格式', + 'description' => '通话记录录音数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['title' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'description' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Type' => ['title' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'description' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'type' => 'string', 'example' => 'record'], + 'File' => ['title' => '录音文件名', 'description' => '录音文件名', 'type' => 'string', 'example' => 'record_file_name.'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'CustomerNumber' => ['title' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'description' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'type' => 'string', 'example' => '01041005968'], + 'RtcTotalDuration' => ['title' => 'RTC总通话时长秒数，单位是s，在呼叫类型为主叫外呼(RTC)时有效，计算规则：endTime-startTime', 'description' => 'RTC总通话时长秒数，单位是s，在呼叫类型为主叫外呼(RTC)时有效，计算规则：endTime-startTime', 'type' => 'string', 'example' => '133'], + 'VadIn' => ['title' => '通话质量百分比,数据是0-100之间，in方向说话占用的百分比', 'description' => '通话质量百分比,数据是0-100之间，in方向说话占用的百分比', 'type' => 'string', 'example' => '30'], + 'CalleeRingingTime' => ['title' => '客户侧响铃时间，时间戳，精确到s，如1480904471', 'description' => '客户侧响铃时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'AgentName' => ['title' => '座席名称', 'description' => '座席名称', 'type' => 'string', 'example' => 'name3'], + 'DownGrade' => ['title' => '是否呼叫降级, 0-否, 1-是', 'description' => '是否呼叫降级, 0-否, 1-是', 'type' => 'string', 'example' => '1'], + 'Status' => ['title' => '外呼结果：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。', 'description' => '外呼结果：30 座席未接听; 31 座席接听,未呼叫客户; 32 座席接听,客户未接听; 33 双方接听; 50 主叫外呼接听; 51 主叫外呼,客户未接听; 52 主叫外呼,双方接听。', 'type' => 'string', 'example' => '33'], + 'UniqueId' => ['title' => '电话唯一标识', 'description' => '电话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'AgentNumber' => ['title' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'description' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'type' => 'string', 'example' => '0104100596'], + 'SipCause' => ['title' => 'SIP响应码：200 ~ 699 详见 注：主叫外呼RTC座席侧没有SIP协商的概念，并未发起呼叫，因此该值默认为0', 'description' => 'SIP响应码：200 ~ 699 详见 注：主叫外呼RTC座席侧没有SIP协商的概念，并未发起呼叫，因此该值默认为0', 'type' => 'string', 'example' => '200'], + 'XNumber' => ['title' => '虚拟号码', 'description' => '虚拟号码', 'type' => 'string', 'example' => '13322444'], + 'CustomerCity' => ['title' => '客户号码归属城市,北京', 'description' => '客户号码归属城市,北京', 'type' => 'string', 'example' => '北京'], + 'StatusReason' => ['title' => '通话状态原因（主叫外呼）描述：1 - 企业黑名单; 2 - 风控系统拦截; 20001 - 呼叫限制；20002 - 黑名单或非白名单；20003 - 禁拨时间段； 3 - 无效的外显号码; 4 - 错误的语音导航; 5 - 企业停机; 6 - 无权限外呼; 7 - 超出呼叫次数限制; 8 - 错误号码; 9 - 其他错误；', 'description' => '通话状态原因（主叫外呼）描述：1 - 企业黑名单; 2 - 风控系统拦截; 20001 - 呼叫限制；20002 - 黑名单或非白名单；20003 - 禁拨时间段； 3 - 无效的外显号码; 4 - 错误的语音导航; 5 - 企业停机; 6 - 无权限外呼; 7 - 超出呼叫次数限制; 8 - 错误号码; 9 - 其他错误；', 'type' => 'string', 'example' => '9'], + 'CallId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'StartTime' => ['title' => '座席开始外呼时间，时间戳，精确到s，如1480904471', 'description' => '座席开始外呼时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'CustomerAreaCode' => ['title' => '客户号码区号', 'description' => '客户号码区号', 'type' => 'string', 'example' => '028'], + 'IsRealAnswer' => ['title' => '是否真人接听：1 - 是、0 - 否、空值', 'description' => '是否真人接听：1 - 是、0 - 否、空值', 'type' => 'string', 'example' => '1'], + 'LeftDisplayNumber' => ['title' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧真实外显号码为虚拟号', 'description' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧真实外显号码为虚拟号', 'type' => 'string', 'example' => '13322225555'], + 'DownGradeCounts' => ['title' => '降级次数', 'description' => '降级次数', 'type' => 'string', 'example' => '1'], + 'TotalDuration' => ['title' => '总通话时长秒数，单位是s', 'description' => '总通话时长秒数，单位是s', 'type' => 'string', 'example' => '30'], + 'MainRingingTime' => ['title' => '分机外呼，话机响铃时间', 'description' => '分机外呼，话机响铃时间', 'type' => 'string', 'example' => '1775024775'], + 'TsiFile' => ['title' => '彩铃文件名称', 'description' => '彩铃文件名称', 'type' => 'string', 'example' => 'name2'], + 'BridgeDuration' => ['title' => '服务处理时长秒数，单位是s', 'description' => '服务处理时长秒数，单位是s', 'type' => 'string', 'example' => '10'], + 'BridgeTime' => ['title' => '双方接听时间，时间戳，精确到s，如1480904471', 'description' => '双方接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'Id' => ['description' => 'Id', 'type' => 'string', 'example' => '9075217226'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取座席外呼通话记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1775024775\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"DisplayNumber\\": \\"41008502\\",\\n \\"TaskId\\": \\"333\\",\\n \\"EndTime\\": \\"1775024875\\",\\n \\"Clid\\": \\"41008502\\",\\n \\"Cno\\": \\"2000\\\\n\\",\\n \\"TrunkGroupKey\\": \\"30020\\",\\n \\"TsiFileFormat\\": \\"mp3\\",\\n \\"UserField\\": {},\\n \\"CallType\\": \\"4\\",\\n \\"Gno\\": \\"133\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"RequestUniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StatusCode\\": \\"33\\",\\n \\"WaitDuration\\": \\"5\\",\\n \\"AgentClid\\": \\"02138276106\\",\\n \\"HangupReason\\": \\"0\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"VadOut\\": \\"70\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"record_file_name.\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"01041005968\\",\\n \\"RtcTotalDuration\\": \\"133\\",\\n \\"VadIn\\": \\"30\\",\\n \\"CalleeRingingTime\\": \\"1775024775\\",\\n \\"AgentName\\": \\"name3\\",\\n \\"DownGrade\\": \\"1\\",\\n \\"Status\\": \\"33\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"AgentNumber\\": \\"0104100596\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"13322444\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"StatusReason\\": \\"9\\",\\n \\"CallId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"StartTime\\": \\"1775024775\\",\\n \\"CustomerAreaCode\\": \\"028\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"LeftDisplayNumber\\": \\"13322225555\\",\\n \\"DownGradeCounts\\": \\"1\\",\\n \\"TotalDuration\\": \\"30\\",\\n \\"MainRingingTime\\": \\"1775024775\\",\\n \\"TsiFile\\": \\"name2\\",\\n \\"BridgeDuration\\": \\"10\\",\\n \\"BridgeTime\\": \\"1775024775\\",\\n \\"Id\\": \\"9075217226\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryPredictiveCallCdr' => [ + 'summary' => '通过本接口，可以查询预测式外呼通话记录信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['title' => '外呼任务id', 'description' => '外呼任务id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '31111'], + ], + [ + 'name' => 'TaskFileId', + 'in' => 'query', + 'schema' => ['title' => '批次id', 'description' => '批次id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '133'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'description' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'description' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'type' => 'string', 'required' => false, 'example' => 'req-uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['title' => '客户电话；客户号码，如：18012345678', 'description' => '客户电话；客户号码，如：18012345678', 'type' => 'string', 'required' => false, 'example' => '18012345678'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号，3-10位数字', 'description' => '座席工号，3-10位数字', 'type' => 'string', 'required' => false, 'example' => '1111'], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['title' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'description' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'WH13'], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['title' => '外显号码；外显的号码', 'description' => '外显号码；外显的号码', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'DisplayNumber', + 'in' => 'query', + 'schema' => ['title' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧的真实外显号码为虚拟号', 'description' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧的真实外显号码为虚拟号', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'DownGrade', + 'in' => 'query', + 'schema' => ['title' => '是否呼叫降级；0-否, 1-是', 'description' => '是否呼叫降级；0-否, 1-是', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '呼叫结果；参数说明：40:预测外呼, 客户未接听； 41:预测外呼, 客户接听； 42: 预测外呼,已呼叫； 43: 预测外呼, 双方接听', 'description' => '呼叫结果；参数说明：40:预测外呼, 客户未接听； 41:预测外呼, 客户接听； 42: 预测外呼,已呼叫； 43: 预测外呼, 双方接听', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '41'], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'description' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'description' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'required' => false, 'example' => '张三'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'description' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'description' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'description' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始取；大于等于0，默认0', 'description' => '从第几条开始取；大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey'], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue'], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['title' => '真人接听；取值说明：1-是、0-否', 'description' => '真人接听；取值说明：1-是、0-否', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '已失效参数，请忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '是否成功。取值：'."\n" - ."\n" - .'- **true**：成功。'."\n" - .'- **false**：失败。', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '预测式外呼通话记录数组', + 'description' => '预测式外呼通话记录数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['title' => '真人接听时间，时间戳，精确到s，如1480904471', 'description' => '真人接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774904471'], + 'NumberTrunk' => ['title' => '中继号码', 'description' => '中继号码', 'type' => 'string', 'example' => '15322355'], + 'CustomerProvince' => ['title' => '客户号码归属省份，如 北京', 'description' => '客户号码归属省份，如 北京', 'type' => 'string', 'example' => '北京'], + 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '1234'], + 'DisplayNumber' => ['title' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧的真实外显号码为虚拟号', 'description' => '客户侧真实外显号码，当使用AXB场景进行外呼时，客户侧的真实外显号码为虚拟号', 'type' => 'string', 'example' => '1775024'], + 'EndTime' => ['title' => '电话结束时间，时间戳，精确到s，如1480904471', 'description' => '电话结束时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'Clid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '02138276106'], + 'Cno' => ['title' => '座席工号，如2000', 'description' => '座席工号，如2000', 'type' => 'string', 'example' => '1111'], + 'TrunkGroupKey' => ['title' => '中继群组代号', 'description' => '中继群组代号', 'type' => 'string', 'example' => '30019'], + 'UserField' => ['title' => '通话记录自定义字段，json格式', 'description' => '通话记录自定义字段，json格式', 'type' => 'object', 'example' => '{}'], + 'CalleeDisplayNumber' => ['title' => '第二侧真实外显号码', 'description' => '第二侧真实外显号码', 'type' => 'string', 'example' => '02138276106'], + 'DetailRingingTime' => ['title' => '话机后话机响铃时间，时间戳，精确到s；无或未转接时可能为 0；如1480904471', 'description' => '话机后话机响铃时间，时间戳，精确到s；无或未转接时可能为 0；如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'CallType' => ['title' => '呼叫类型 webcall', 'description' => '呼叫类型', 'type' => 'string', 'example' => '预测外呼'], + 'Gno' => ['title' => '外呼组号：座席所属外呼组编号，如2000', 'description' => '外呼组号：座席所属外呼组编号，如2000', 'type' => 'string', 'example' => '2000'], + 'AnswerTime' => ['title' => '系统接听时间，时间戳，精确到s，如1480904471', 'description' => '系统接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'StatusCode' => ['title' => '外呼结果状态码：40 客户未接听；41 客户接听；42 已呼叫；43 双方接听；详见接口文档请求参数中 status 说明', 'description' => '外呼结果状态码：40 客户未接听；41 客户接听；42 已呼叫；43 双方接听；详见接口文档请求参数中 status 说明', 'type' => 'string', 'example' => '41'], + 'RequestUniqueId' => ['title' => '用户自定义通话标识字段', 'description' => '用户自定义通话标识字段', 'type' => 'string', 'example' => '543252344'], + 'CalleeClid' => ['title' => '第二侧外显号码', 'description' => '第二侧外显号码', 'type' => 'string', 'example' => '15553333'], + 'WaitDuration' => ['title' => '客户等待时长秒数，单位是s', 'description' => '客户等待时长秒数，单位是s', 'type' => 'string', 'example' => '10'], + 'EndReason' => ['title' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'description' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'type' => 'string', 'example' => '1000'], + 'Qno' => ['title' => '队列号，如1000', 'description' => '队列号，如1000', 'type' => 'string', 'example' => '1000'."\n" + ."\n"], + 'VadOut' => ['title' => '通话质量百分比，0–100，in/out 方向说话占用百分比', 'description' => '通话质量百分比，0–100，in/out 方向说话占用百分比', 'type' => 'string', 'example' => '77'], + 'RecordFile' => [ + 'title' => '通话记录录音数组，json格式', + 'description' => '通话记录录音数组，json格式', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['title' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'description' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Type' => ['title' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'description' => '取值：record,voicemail 说明：record是录音， voicemail是留言', 'type' => 'string', 'example' => 'record'], + 'File' => ['title' => '录音文件名', 'description' => '录音文件名', 'type' => 'string', 'example' => 'name3'], + ], + 'description' => '', + ], + 'example' => '', + ], + 'CustomerNumber' => ['title' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'description' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'type' => 'string', 'example' => '18701051984'], + 'VadIn' => ['title' => '通话质量百分比，0–100，in/out 方向说话占用百分比', 'description' => '通话质量百分比，0–100，in/out 方向说话占用百分比', 'type' => 'string', 'example' => '23'], + 'CalleeRingingTime' => ['title' => '客户响铃时间，时间戳，精确到s，如1480904471', 'description' => '客户响铃时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'AgentName' => ['title' => '座席姓名, 如\'张三1010\'', 'description' => '座席姓名, 如\'张三1010\'', 'type' => 'string', 'example' => '张三1010'], + 'DownGrade' => ['title' => '是否呼叫降级, 0-否, 1-是', 'description' => '是否呼叫降级, 0-否, 1-是', 'type' => 'string', 'example' => '0'], + 'IvrName' => ['title' => 'IVR名称，默认自定义', 'description' => 'IVR名称，默认自定义', 'type' => 'string', 'example' => 'IvrName'], + 'Status' => ['title' => '外呼结果， 如客户接听', 'description' => '外呼结果， 如客户接听', 'type' => 'string', 'example' => '客户接听'], + 'UniqueId' => ['title' => '电话唯一标识', 'description' => '电话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'SipCause' => ['title' => '号码状态识别编码，详见', 'description' => '号码状态识别编码，详见', 'type' => 'string', 'example' => '200'], + 'XNumber' => ['title' => '虚拟号', 'description' => '虚拟号', 'type' => 'string', 'example' => '6677333'], + 'CustomerCity' => ['title' => '客户号码归属城市,北京', 'description' => '客户号码归属城市,北京', 'type' => 'string', 'example' => '北京'], + 'CallId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => '3cdf8d08-0216-42df-bba5-0fd45c93c9b3'], + 'StartTime' => ['title' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'description' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822300'], + 'SipCauseStr' => ['title' => '呼叫结果', 'description' => '呼叫结果', 'type' => 'string', 'example' => '处理成功'], + 'TaskFileId' => ['title' => '任务文件id', 'description' => '任务文件id', 'type' => 'string', 'example' => '111'], + 'IsRealAnswer' => ['title' => '是否真人接听：1 - 是、0 - 否、空值', 'description' => '是否真人接听：1 - 是、0 - 否、空值', 'type' => 'string', 'example' => '1'], + 'DownGradeCounts' => ['title' => '降级次数', 'description' => '降级次数', 'type' => 'string', 'example' => '0'], + 'CalleeNumber' => ['title' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'description' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'type' => 'string', 'example' => '0104100596'], + 'TotalDuration' => ['title' => '总通话时长秒数，单位是s', 'description' => '总通话时长秒数，单位是s', 'type' => 'string', 'example' => '55'], + 'TaskName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'name2'], + 'BridgeDuration' => ['title' => '服务处理时长秒数，单位是s', 'description' => '服务处理时长秒数，单位是s', 'type' => 'string', 'example' => '50'], + 'Id' => ['title' => '通话记录主键标识；', 'description' => '通话记录主键标识；', 'type' => 'string', 'example' => '123546546'], + 'BridgeTime' => ['title' => '座席接听时间，时间戳，精确到s，如1480904471', 'description' => '座席接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822305'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<TaskId>4001112222</TaskId>\\n</DeleteRobotTaskResponse>","errorExample":""}]', - 'title' => '删除智能语音任务', - 'summary' => '删除智能语音任务。', - 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'- 此接口仅支持删除未开始状态、已完成状态以及被终止的任务。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotv2AllList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '预测式外呼通话记录', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1774904471\\",\\n \\"NumberTrunk\\": \\"15322355\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"TaskId\\": \\"1234\\",\\n \\"DisplayNumber\\": \\"1775024\\",\\n \\"EndTime\\": \\"1775024775\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"1111\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"UserField\\": {},\\n \\"CalleeDisplayNumber\\": \\"02138276106\\",\\n \\"DetailRingingTime\\": \\"1775024775\\",\\n \\"CallType\\": \\"预测外呼\\",\\n \\"Gno\\": \\"2000\\",\\n \\"AnswerTime\\": \\"1775024775\\",\\n \\"StatusCode\\": \\"41\\",\\n \\"RequestUniqueId\\": \\"543252344\\",\\n \\"CalleeClid\\": \\"15553333\\",\\n \\"WaitDuration\\": \\"10\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\\\n\\\\n\\",\\n \\"VadOut\\": \\"77\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\"name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"VadIn\\": \\"23\\",\\n \\"CalleeRingingTime\\": \\"1775024775\\",\\n \\"AgentName\\": \\"张三1010\\",\\n \\"DownGrade\\": \\"0\\",\\n \\"IvrName\\": \\"IvrName\\",\\n \\"Status\\": \\"客户接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"XNumber\\": \\"6677333\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"CallId\\": \\"3cdf8d08-0216-42df-bba5-0fd45c93c9b3\\",\\n \\"StartTime\\": \\"1774822300\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"TaskFileId\\": \\"111\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"DownGradeCounts\\": \\"0\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"55\\",\\n \\"TaskName\\": \\"name2\\",\\n \\"BridgeDuration\\": \\"50\\",\\n \\"Id\\": \\"123546546\\",\\n \\"BridgeTime\\": \\"1774822305\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryRasrEvent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'required' => true, 'example' => 'uniq_1-162046xxxx.12'], + ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '废弃参数', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '机器人话术信息。JSON格式。'."\n" - .'- **id**：机器人话术ID。'."\n" - .'- **robotName**：机器人话术名称。'."\n" - .'- **robotType**：机器人话术类型。'."\n", - 'type' => 'string', - 'example' => '{"id":100000007****,"robotName":"机器人","robotType":"CUSTOM"}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => '返回数据', + 'description' => '返回数据', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UniqueId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => 'sip-2-1480660149.0'], + 'OutRecordFile' => ['title' => '机器人侧录音文件名', 'description' => '机器人侧录音文件名', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-out'], + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1768615738'], + 'Cno' => ['title' => '坐席工号', 'description' => '坐席工号', 'type' => 'string', 'example' => '1111'], + 'RasrDuration' => ['title' => '持续时间', 'description' => '持续时间', 'type' => 'string', 'example' => '333'], + 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '96'], + 'Text' => ['title' => '客户对话文本信息', 'description' => '客户对话文本信息', 'type' => 'string', 'example' => '[{\\"text\\":\\"示例客户话术\\",\\"beginTime\\":\\"100\\",\\"endTime\\":\\"200\\",\\"sentenceId\\":\\"example\\"}]'], + 'EnterpriseId' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'string', 'example' => '7000002'], + 'MainUniqueId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => 'sip-2-1558615724.87'], + 'RecordFile' => ['title' => '客户侧录音文件名', 'description' => '客户侧录音文件名', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-in'], + 'CustomerNumber' => ['title' => '客户号码', 'description' => '客户号码', 'type' => 'string', 'example' => '177xxxx1313'], + 'MixRecordFile' => ['title' => '混音录音文件名', 'description' => '混音录音文件名', 'type' => 'string', 'example' => 'sip-2-1558615724.87-54529-mix'], + 'BotText' => ['title' => '机器人对话文本信息', 'description' => '机器人对话文本信息', 'type' => 'string', 'example' => '[{\\"text\\":\\"机器人话术示例\\",\\"beginTime\\":\\"1639471934\\"}]'], + 'MonitorSide' => ['title' => '1:座席侧（webcall是第二侧），2:客户侧（webcall是第一侧）', 'description' => '1:座席侧（webcall是第二侧），2:客户侧（webcall是第一侧）', 'type' => 'string', 'example' => '2'], + 'Engine' => ['title' => '引擎', 'description' => '引擎', 'type' => 'string', 'example' => '""'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":100000007****,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\"}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotv2AllListResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>{\\"id\\":100000007****,\\"robotName\\":\\"机器人\\",\\"robotType\\":\\"CUSTOM\\"}</Data>\\n</QueryRobotv2AllListResponse>","errorExample":""}]', - 'title' => '获取全部机器人话术模板列表', - 'summary' => '获取全部机器人话术模板列表。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取RASR信息', + 'summary' => '通过uniqueId获取rasr信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"UniqueId\\": \\"sip-2-1480660149.0\\",\\n \\"OutRecordFile\\": \\"sip-2-1558615724.87-54529-out\\",\\n \\"EndTime\\": 1768615738,\\n \\"Cno\\": \\"1111\\",\\n \\"RasrDuration\\": \\"333\\",\\n \\"StartTime\\": 96,\\n \\"Text\\": \\"[{\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"示例客户话术\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"beginTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"200\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sentenceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\"}]\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"MainUniqueId\\": \\"sip-2-1558615724.87\\",\\n \\"RecordFile\\": \\"sip-2-1558615724.87-54529-in\\",\\n \\"CustomerNumber\\": \\"177xxxx1313\\",\\n \\"MixRecordFile\\": \\"sip-2-1558615724.87-54529-mix\\",\\n \\"BotText\\": \\"[{\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"机器人话术示例\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"beginTime\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1639471934\\\\\\\\\\\\\\"}]\\",\\n \\"MonitorSide\\": \\"2\\",\\n \\"Engine\\": \\"\\\\\\"\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudQueryTask' => [ + 'summary' => '获取呼叫任务列表，支持按照条件查询。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '任务名称。', - 'type' => 'string', - 'required' => false, - 'example' => '任务测试', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '任务类型；1.预测外呼任务 2.自动外呼任务', 'description' => '任务类型；1：预测外呼任务，2：自动外呼任务', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '任务名称；需进行UTF-8格式的URLEncode编码', 'description' => '任务名称；需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => false, 'example' => 'name1'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '任务状态。取值：'."\n" - .'- **INIT**：未开始。'."\n" - .'- **READY**：准备开始。'."\n" - .'- **DISPATCH**：解析中。'."\n" - .'- **EXCUTING**：执行中。'."\n" - .'- **MANUAL_STOP**：手动暂停。'."\n" - .'- **SYSTEM_STOP**：系统暂停。'."\n" - .'- **ARREARS_STOP**：欠费暂停。'."\n" - .'- **CANCEL**：手动终止。'."\n" - .'- **SYSTEM_CANCEL**：系统终止。'."\n" - .'- **FINISH**：已完成。', - 'type' => 'string', - 'required' => false, - 'example' => 'EXCUTING', - ], + 'schema' => ['title' => '任务状态；0.初始 1.运行中 2.暂停 3.结束', 'description' => '任务状态；0.初始 1.运行中 2.暂停 3.结束', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], ], [ - 'name' => 'Time', + 'name' => 'AutoStart', 'in' => 'query', - 'schema' => [ - 'description' => '任务创建日期。格式：yyyy-MM-dd。', - 'type' => 'string', - 'required' => false, - 'example' => '2019-06-14', - ], + 'schema' => ['title' => '定时开始；0.关闭 1.开启', 'description' => '定时开始；0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'PageSize', + 'name' => 'AutoStop', 'in' => 'query', - 'schema' => [ - 'description' => '每页个数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '定时结束；0.关闭 1.开启', 'description' => '定时结束；0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'PageNo', + 'name' => 'TimeType', 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '时间过滤条件；1.任务启动时间 2.任务结束时间 3.任务创建时间', 'description' => '时间过滤条件；1.任务启动时间 2.任务结束时间 3.任务创建时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '查询开始时间；格式说明："2019-10-11 00:00:00"', 'description' => '查询开始时间；格式说明："2019-10-11 00:00:00"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '查询结束时间；格式说明："2019-10-11 23:59:59"', 'description' => '查询结束时间；格式说明："2019-10-11 23:59:59"', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 20:00:00'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始获取；大于等于0，默认0', 'description' => '从第几条开始获取；大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过100，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过100，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => 'None'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '智能语音任务列表。JSON格式。取值：'."\n" - .'- **id**：机器人呼叫任务的唯一任务ID。'."\n" - .'- **taskName**：任务名称。'."\n" - .'- **robotId**：指定机器人ID。'."\n" - .'- **robotName**：机器人名称。'."\n" - .'- **status**：任务状态。'."\n" - .'- **scheduleType**：调度类型。**SINGLE**为立即启动，**ORDER**为定时启动。'."\n" - .'- **createTime**：任务创建时间。yyyy.MM.dd HH:mm:ss格式。'."\n" - .'- **completeTime**：任务完成时间。yyyy.MM.dd HH:mm:ss格式。'."\n" - .'- **fireTime**：任务启动时间。yyyy.MM.dd HH:mm:ss格式。'."\n" - .'- **totalCount**：处理通话总数。'."\n" - .'- **finishCount**：完成通话个数。', - 'type' => 'string', - 'example' => '[ {"id": 1045001, "taskName": "智能语音任务", "robotId": 1000000075003, "robotName": "机器人", "status": "INIT","scheduleType": "SINGLE", "createTime": "2019.06.14 14:55:23", "completeTime": "2019.06.14 14:55:23", "fireTime": "2019.06.14 14:55:23", "totalCount": 1000, "finishCount": 998} ]', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'PageNo' => [ - 'description' => '每页个数。', - 'type' => 'string', - 'example' => '1', - ], - 'Code' => [ - 'description' => '请求状态码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'PageSize' => [ - 'description' => '页码。', - 'type' => 'string', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => '总任务数。', - 'type' => 'string', - 'example' => '1', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TaskProperties' => [ + 'description' => '任务列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallVariables' => ['title' => '座席通道变量', 'description' => '座席通道变量', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'OverTime' => ['title' => '任务结束时间', 'description' => '任务结束时间', 'type' => 'string', 'example' => 'example'], + 'CustomerClidType' => ['title' => '客户侧外显规则，1.随机 2.按区号', 'description' => '客户侧外显规则，1.随机 2.按区号', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CustomerVoice' => ['title' => '客户侧提示音', 'description' => '客户侧提示音', 'type' => 'string', 'example' => 'example'], + 'EnterpriseId' => ['title' => '呼叫中心Id', 'description' => '呼叫中心Id', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '任务名称 ', 'description' => '任务名称 ', 'type' => 'string', 'example' => 'name1'], + 'Cnos' => ['title' => '座席工号列表', 'description' => '座席工号列表', 'type' => 'string', 'example' => '1111,2222'], + 'Concurrency' => ['title' => '最大并发限制', 'description' => '最大并发限制', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'StatusDescription' => ['title' => '任务状态描述', 'description' => '任务状态描述', 'type' => 'string', 'example' => '""'], + 'AgentGroup' => ['title' => '外呼组号', 'description' => '外呼组号', 'type' => 'string', 'example' => 'WH124'], + 'CustomerClids' => ['title' => '客户侧外显号码列表', 'description' => '客户侧外显号码列表', 'type' => 'string', 'example' => '02138276106'], + 'AutoComplete' => ['title' => '自动完成，0.关闭 1.开启 ', 'description' => '自动完成，0.关闭 1.开启 ', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AutoStart' => ['title' => '定时开始，0.关闭 1.开启', 'description' => '定时开始，0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CustomerClidWeightFlag' => ['title' => '外显号码比例配置开关，0.关闭 1.开启', 'description' => '外显号码比例配置开关，0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Status' => ['title' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'description' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'PauseTime' => ['title' => '任务暂停时间点', 'description' => '任务暂停时间点', 'type' => 'string', 'example' => '2026-04-20 11:00:00'], + 'AutoStartDay' => ['title' => '定时开始日期，格式：yyyy-MM-dd，如：2017-02-11', 'description' => '定时开始日期，格式：yyyy-MM-dd，如：2017-02-11', 'type' => 'string', 'example' => '2017-02-11'], + 'ClidProperty' => ['title' => '外显规则，Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'description' => '外显规则，Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}', 'type' => 'string', 'example' => 'example'], + 'RetryStrategyOnlyToday' => ['title' => '重试仅当天生效，0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据', 'description' => '重试仅当天生效，0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'WarmUpDuration' => ['title' => '任务预热时间，单位秒', 'description' => '任务预热时间，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '9'], + 'PredictAdjust' => ['title' => '超呼率', 'description' => '超呼率', 'type' => 'integer', 'format' => 'int64', 'example' => '60'], + 'StartTime' => ['title' => '任务开始时间', 'description' => '任务开始时间', 'type' => 'string', 'example' => '09:00'], + 'AutoTaskType' => ['title' => '呼叫方式，0.连续呼叫 1.间隔呼叫', 'description' => '呼叫方式，0.连续呼叫 1.间隔呼叫', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'AutoStartTime' => ['title' => '定时开始时间，格式：HH:mm:ss，如：08:00:00', 'description' => '定时开始时间，格式：HH:mm:ss，如：08:00:00', 'type' => 'string', 'example' => '08:00:00'], + 'ForceEndFlag' => ['title' => '定时完成时强制结束任务，开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。 0：否，1：是', 'description' => '定时完成时强制结束任务，开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。 0：否，1：是', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Id' => ['title' => '外呼任务Id ', 'description' => '外呼任务Id ', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], + 'Quotiety' => ['title' => '骚扰率，支持小数，精确到小数点两位', 'description' => '骚扰率，支持小数，精确到小数点两位', 'type' => 'number', 'format' => 'double', 'example' => '1.0'], + 'AutoTriggerTimeStrategy' => ['title' => '间隔呼叫时间段，呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22', 'description' => '间隔呼叫时间段，呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22', 'type' => 'string', 'example' => '9,22'], + 'RetryStrategy' => ['title' => '重试策略， 「基础模式」 数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}``` 格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟 「高级模式」 高级模式需要开启「号码状态识别」服务后。目前只支持「自动外呼」任务模式。 数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]``` 格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致', 'description' => '重试策略， 「基础模式」 数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}``` 格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟 「高级模式」 高级模式需要开启「号码状态识别」服务后。目前只支持「自动外呼」任务模式。 数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]``` 格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致', 'type' => 'string', 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}'], + 'CustomerTimeout' => ['title' => '客户超时时间，单位秒', 'description' => '客户超时时间，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '17'], + 'Description' => ['title' => '任务描述', 'description' => '任务描述', 'type' => 'string', 'example' => 'desc'], + 'AutoStopDay' => ['title' => ' 定时完成日期，格式：yyyy-MM-dd，如：2017-02-11', 'description' => ' 定时完成日期，格式：yyyy-MM-dd，如：2017-02-11', 'type' => 'string', 'example' => '2017-02-11'], + 'TimeStrategy' => ['title' => '禁止呼叫时间限制，在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'description' => '禁止呼叫时间限制，在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。', 'type' => 'string', 'example' => '9,22'], + 'CustomerClidWeight' => ['title' => '外显号码比例配置内容', 'description' => '外显号码比例配置内容', 'type' => 'string', 'example' => '[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]'], + 'MinAvailableAgentCount' => ['title' => '最小可用座席数', 'description' => '最小可用座席数', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'AgentTimeout' => ['title' => '座席超时时间，单位秒', 'description' => '座席超时时间，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'AnswerRate' => ['title' => '初始化预计客户接通率 ', 'description' => '初始化预计客户接通率 ', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'CustomerMoh' => ['title' => '客户侧等待音', 'description' => '客户侧等待音', 'type' => 'string', 'example' => 'no'], + 'UserFields' => ['title' => '任务自定义字段', 'description' => '任务自定义字段', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'CallGroupType' => ['title' => '指定座席方式，1.座席工号列表 2.外呼组', 'description' => '指定座席方式，1.座席工号列表 2.外呼组', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CreateTime' => ['title' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'description' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2025-10-12 18:03:14'], + 'OverCallLimitCnos' => ['title' => '超过呼叫限制的座席', 'description' => '超过呼叫限制的座席', 'type' => 'string', 'example' => '0'], + 'PauseDuration' => ['title' => '任务暂停时长(针对自动启动时间段) 单位分钟', 'description' => '任务暂停时长(针对自动启动时间段) 单位分钟', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AutoStop' => ['title' => '定时完成，0.关闭 1.开启', 'description' => '定时完成，0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Wrapup' => ['title' => '座席整理时间，单位秒', 'description' => '座席整理时间，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'MaxWaitTime' => ['title' => '座席最大等待时间，单位秒', 'description' => '座席最大等待时间，单位秒', 'type' => 'integer', 'format' => 'int64', 'example' => '34'], + 'CallRouteStrategy' => ['title' => '呼叫流转模式， 1.直连座席 2.AI转人工 直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验 AI转人工：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本', 'description' => '呼叫流转模式， 1.直连座席 2.AI转人工 直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验 AI转人工：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'StatusTriggerType' => ['title' => '任务状态变更类型，0.系统变更 1.人为变更', 'description' => '任务状态变更类型，0.系统变更 1.人为变更', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'CallPriorityStrategy' => ['title' => '呼叫顺序，数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```，格式说明：sort是重试号码和未呼叫号码的呼叫顺序 ，type：retryCall重试号码、firstCall未呼叫号码，当type=retryCall，desc：0.优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫 1.优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫，当type=firstCall时，orderType：随机呼叫，0顺序(优先级) 1随机 2顺序(导入时间)', 'description' => '呼叫顺序，数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```，格式说明：sort是重试号码和未呼叫号码的呼叫顺序 ，type：retryCall重试号码、firstCall未呼叫号码，当type=retryCall，desc：0.优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫 1.优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫，当type=firstCall时，orderType：随机呼叫，0顺序(优先级) 1随机 2顺序(导入时间)', 'type' => 'string', 'example' => '{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}'], + 'Type' => ['title' => '任务类型，1.预测外呼任务 2.自动外呼任务', 'description' => '任务类型，1.预测外呼任务 2.自动外呼任务', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IsRewarm' => ['title' => '暂停后重新预热，0.关闭，1开启', 'description' => '暂停后重新预热，0.关闭，1开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetryStrategyTimeType' => ['title' => '重试策略时间类型，1.基于首次呼叫时间 2.基于上次呼叫时间', 'description' => '重试策略时间类型，1.基于首次呼叫时间 2.基于上次呼叫时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AutoStopTime' => ['title' => '定时完成时间，格式：HH:mm:ss，如：17:00:00', 'description' => '定时完成时间，格式：HH:mm:ss，如：17:00:00', 'type' => 'string', 'example' => '17:00:00'."\n" + ."\n"], + 'CallLimitStrategy' => ['title' => '座席当日接听数限制，JsonArray格式[{"cnos":["2000","2001"],"limit":"5"}]', 'description' => '座席当日接听数限制，JsonArray格式[{"cnos":["2000","2001"],"limit":"5"}]', 'type' => 'string', 'example' => '[{"cnos":["2000","2001"],"limit":"5"}]'], + 'CallStrategy' => ['title' => '座席分配规则，1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长）', 'description' => '座席分配规则，1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'IvrId' => ['title' => '语音导航Id，预测外呼使用场景：直连座席模式下如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效。AI转人工模式下，呼叫先转到语音导航 自动外呼使用场景：客户接听后，转到的语音导航', 'description' => '语音导航Id，预测外呼使用场景：直连座席模式下如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效。AI转人工模式下，呼叫先转到语音导航 自动外呼使用场景：客户接听后，转到的语音导航', 'type' => 'integer', 'format' => 'int64', 'example' => '133'], + 'CustomerClidsCategory' => ['title' => '客户侧外显号码类型，1.外显固话 2.外显手机号 4.外显号码池 5.外显导航', 'description' => '客户侧外显号码类型，1.外显固话 2.外显手机号 4.外显号码池 5.外显导航', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '响应码', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {\\\\\\"id\\\\\\": 1045001, \\\\\\"taskName\\\\\\": \\\\\\"智能语音任务\\\\\\", \\\\\\"robotId\\\\\\": 1000000075003, \\\\\\"robotName\\\\\\": \\\\\\"机器人\\\\\\", \\\\\\"status\\\\\\": \\\\\\"INIT\\\\\\",\\\\\\"scheduleType\\\\\\": \\\\\\"SINGLE\\\\\\", \\\\\\"createTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"completeTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"fireTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"totalCount\\\\\\": 1000, \\\\\\"finishCount\\\\\\": 998} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"PageNo\\": \\"1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskListResponse>\\n <Data>[ {\\"id\\": 1045001, \\"taskName\\": \\"智能语音任务\\", \\"robotId\\": 1000000075003, \\"robotName\\": \\"机器人\\", \\"status\\": \\"INIT\\",\\"scheduleType\\": \\"SINGLE\\", \\"createTime\\": \\"2019.06.14 14:55:23\\", \\"completeTime\\": \\"2019.06.14 14:55:23\\", \\"fireTime\\": \\"2019.06.14 14:55:23\\", \\"totalCount\\": 1000, \\"finishCount\\": 998} ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <PageNo>1</PageNo>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <PageSize>1</PageSize>\\n <TotalCount>1</TotalCount>\\n</QueryRobotTaskListResponse>","errorExample":""}]', - 'title' => '获取所有任务ID', - 'summary' => '获取所有语音任务信息。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - ."\n" - .'### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取呼叫任务列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TaskProperties\\": [\\n {\\n \\"CallVariables\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"OverTime\\": \\"example\\",\\n \\"CustomerClidType\\": 1,\\n \\"CustomerVoice\\": \\"example\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"name1\\",\\n \\"Cnos\\": \\"1111,2222\\",\\n \\"Concurrency\\": 3,\\n \\"StatusDescription\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AgentGroup\\": \\"WH124\\",\\n \\"CustomerClids\\": \\"02138276106\\",\\n \\"AutoComplete\\": 0,\\n \\"AutoStart\\": 0,\\n \\"CustomerClidWeightFlag\\": 0,\\n \\"Status\\": 2,\\n \\"PauseTime\\": \\"2026-04-20 11:00:00\\",\\n \\"AutoStartDay\\": \\"2017-02-11\\",\\n \\"ClidProperty\\": \\"example\\",\\n \\"RetryStrategyOnlyToday\\": 4,\\n \\"WarmUpDuration\\": 9,\\n \\"PredictAdjust\\": 60,\\n \\"StartTime\\": \\"09:00\\",\\n \\"AutoTaskType\\": 50,\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"ForceEndFlag\\": 0,\\n \\"Id\\": 59,\\n \\"Quotiety\\": 1,\\n \\"AutoTriggerTimeStrategy\\": \\"9,22\\",\\n \\"RetryStrategy\\": \\"{\\\\\\"retry\\\\\\":2,\\\\\\"strategy\\\\\\":[{\\\\\\"round\\\\\\":1,\\\\\\"time\\\\\\":\\\\\\"1-1-1\\\\\\"},{\\\\\\"round\\\\\\":2,\\\\\\"time\\\\\\":\\\\\\"2-2-2\\\\\\"}]}\\",\\n \\"CustomerTimeout\\": 17,\\n \\"Description\\": \\"desc\\",\\n \\"AutoStopDay\\": \\"2017-02-11\\",\\n \\"TimeStrategy\\": \\"9,22\\",\\n \\"CustomerClidWeight\\": \\"[{\\\\\\"number\\\\\\":\\\\\\"123,345\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"},{\\\\\\"number\\\\\\":\\\\\\"567,789\\\\\\",\\\\\\"weight\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"MinAvailableAgentCount\\": 2,\\n \\"AgentTimeout\\": 10,\\n \\"AnswerRate\\": 50,\\n \\"CustomerMoh\\": \\"no\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"CallGroupType\\": 1,\\n \\"CreateTime\\": \\"2025-10-12 18:03:14\\",\\n \\"OverCallLimitCnos\\": \\"0\\",\\n \\"PauseDuration\\": 1,\\n \\"AutoStop\\": 0,\\n \\"Wrapup\\": 13,\\n \\"MaxWaitTime\\": 34,\\n \\"CallRouteStrategy\\": 1,\\n \\"StatusTriggerType\\": 0,\\n \\"CallPriorityStrategy\\": \\"{\\\\\\"strategy\\\\\\":[{\\\\\\"sort\\\\\\":1,\\\\\\"type\\\\\\":\\\\\\"retryCall\\\\\\", \\\\\\"desc\\\\\\":0},{\\\\\\"sort\\\\\\":2,\\\\\\"type\\\\\\":\\\\\\"firstCall\\\\\\",\\\\\\"orderType\\\\\\":0}]}\\",\\n \\"Type\\": 1,\\n \\"IsRewarm\\": 0,\\n \\"RetryStrategyTimeType\\": 1,\\n \\"AutoStopTime\\": \\"17:00:00\\\\n\\\\n\\",\\n \\"CallLimitStrategy\\": \\"[{\\\\\\"cnos\\\\\\":[\\\\\\"2000\\\\\\",\\\\\\"2001\\\\\\"],\\\\\\"limit\\\\\\":\\\\\\"5\\\\\\"}]\\",\\n \\"CallStrategy\\": 1,\\n \\"IvrId\\": 133,\\n \\"CustomerClidsCategory\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryCallDetailByTaskId' => [ - 'methods' => [ - 'post', - 'get', + 'CloudQueryWebcallCdr' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'UniqueId', + 'in' => 'query', + 'schema' => ['title' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'description' => '如果uniqueId值不为空，则以下其它参数无效，即仅查询电话唯一标识为uniqueId的记录信息', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'description' => '查询请求唯一id对应的记录信息，默认查询当前月，如requestUniqueId不属于当前月，查询时请传递查询参数 查询开始时间(startTime)', 'type' => 'string', 'required' => false, 'example' => 'uniq_1-162046xxxx.12'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '呼叫结果；参数说明： 20 webcall, TTS合成失败； 21 webcall, 客户未接 ； 22:webcall, 客户接听； 23: webcall； 已呼叫； 24: webcall, 双方接听；', 'description' => '呼叫结果；参数说明： 20 webcall, TTS合成失败； 21 webcall, 客户未接 ； 22:webcall, 客户接听； 23: webcall； 已呼叫； 24: webcall, 双方接听；', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], + ], + [ + 'name' => 'Province', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'description' => '客户电话归属省份；为空表示全部，如"四川"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => ['title' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'description' => '客户电话归属城市；为空表示全部，如"成都"，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'TimeRangeType', + 'in' => 'query', + 'schema' => ['title' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'description' => '查询时间开始结束范围生效类型；通话记录startTime和endTime时间范围生效类型，当startTime和endTime不为空时生效；取值：1.呼叫开始时间 2.呼叫结束时间； 默认为1', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'description' => '查询开始时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份第一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'description' => '查询结束时间；时间戳格式,精确到s。startTime与endTime不允许跨月，默认值取当前月份最后一天', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1775024775'], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => ['title' => '从第几条开始取；大于等于0，默认0', 'description' => '从第几条开始取；大于等于0，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => ['title' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'description' => '需要取出的数据条数；大于0，最大不能超过1000，默认10', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'UserFieldkey', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询key；传递该参数时必须传递userFieldValue，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldkey'], + ], + [ + 'name' => 'UserFieldValue', + 'in' => 'query', + 'schema' => ['title' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'description' => '用户自定义参数指定查询value；传递该参数时必须传递userFieldKey，仅查询一个字段，不支持模糊匹配，构造的自定义字段查询条件为:{"userFieldkey":"userFieldvalue"}，此参数需要URLEncode', 'type' => 'string', 'required' => false, 'example' => 'userFieldvalue'], + ], + [ + 'name' => 'CustomerNumber', + 'in' => 'query', + 'schema' => ['title' => '客户号码', 'description' => '客户号码', 'type' => 'string', 'required' => false, 'example' => '01042003255'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'required' => false, 'example' => '1111'], + ], + [ + 'name' => 'Gno', + 'in' => 'query', + 'schema' => ['title' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'description' => '座席所属外呼组 单个外呼组号2-20位，支持一个或多个座席工号查询，多个座席工号以英文逗号隔开，一次最多支持10个。不支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => '233'], + ], + [ + 'name' => 'CalleeNumber', + 'in' => 'query', + 'schema' => ['title' => '座席号码', 'description' => '座席号码', 'type' => 'string', 'required' => false, 'example' => '01041009283'], + ], + [ + 'name' => 'DisplayNumber', + 'in' => 'query', + 'schema' => ['title' => '真实外显号码，当使用AXB场景进行外呼时，真实外显号码为虚拟号', 'description' => '真实外显号码，当使用AXB场景进行外呼时，真实外显号码为虚拟号', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'CalleeDisplayNumber', + 'in' => 'query', + 'schema' => ['title' => '第二侧真实外显号码', 'description' => '第二侧真实外显号码', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'CalleeClid', + 'in' => 'query', + 'schema' => ['title' => '第二侧外显号码', 'description' => '第二侧外显号码', 'type' => 'string', 'required' => false, 'example' => '02138276106'], + ], + [ + 'name' => 'ReturnCount', + 'in' => 'query', + 'schema' => ['title' => '是否返回总条数；取值说明：0: 不返回，1：返回，不传默认为1', 'description' => '是否返回总条数；取值说明：0: 不返回，1：返回，不传默认为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsRealAnswer', + 'in' => 'query', + 'schema' => ['title' => '真人接听；取值说明：1-是、0-否', 'description' => '真人接听；取值说明：1-是、0-否', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], + 'Message' => ['description' => '信息', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'List' => [ + 'title' => 'webcall通话记录数组', + 'description' => 'webcall通话记录数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RealAnswerTime' => ['title' => '真人接听时间，时间戳，精确到s，如1480904471', 'description' => '真人接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1775024775'], + 'NumberTrunk' => ['title' => '中继号码', 'description' => '中继号码', 'type' => 'string', 'example' => '42003255'], + 'CustomerProvince' => ['title' => '客户号码归属省份，如 北京', 'description' => '客户号码归属省份，如 北京', 'type' => 'string', 'example' => '北京'], + 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '13354'], + 'DisplayNumber' => ['title' => '真实外显号码，当使用AXB场景进行外呼时，真实外显号码为虚拟号', 'description' => '真实外显号码，当使用AXB场景进行外呼时，真实外显号码为虚拟号', 'type' => 'string', 'example' => '02138276106'], + 'EndTime' => ['title' => '电话结束时间，时间戳，精确到s，如1480904471', 'description' => '电话结束时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822312'], + 'Clid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '02138276106'], + 'Cno' => ['title' => '座席工号，如2000', 'description' => '座席工号，如2000', 'type' => 'string', 'example' => '2000'], + 'TrunkGroupKey' => ['title' => '中继组标识', 'description' => '中继组标识', 'type' => 'string', 'example' => '30019'], + 'CalleeDisplayNumber' => ['title' => '第二侧真实外显号码', 'description' => '第二侧真实外显号码', 'type' => 'string', 'example' => '02138276106'], + 'DetailRingingTime' => ['title' => '转话机后,话机响铃时间', 'description' => '转话机后,话机响铃时间', 'type' => 'string', 'example' => '1774822303'], + 'CallType' => ['title' => '呼叫类型 webcall', 'description' => '呼叫类型 webcall', 'type' => 'string', 'example' => 'webcall'], + 'Gno' => ['description' => '座席外呼组号', 'type' => 'string', 'example' => 'WH333'], + 'AnswerTime' => ['title' => '系统接听时间，时间戳，精确到s，如1480904471', 'description' => '系统接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822302'], + 'StatusCode' => ['title' => 'status对应的状态码', 'description' => 'status对应的状态码', 'type' => 'string', 'example' => '24'], + 'RequestUniqueId' => ['title' => '用户自定义通话标识字段', 'description' => '用户自定义通话标识字段', 'type' => 'string', 'example' => '214b76605a43d02f4aab4e61cfa63128'], + 'CalleeClid' => ['title' => '第二侧外显号码', 'description' => '第二侧外显号码', 'type' => 'string', 'example' => '02138276106'], + 'WaitDuration' => ['description' => '等待时长', 'type' => 'string', 'example' => '6'], + 'EndReason' => ['title' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'description' => '结束原因,接听之后的挂机原因 1000:主通道挂机 1001:非主通道挂机 1002:被强拆', 'type' => 'string', 'example' => '1000'], + 'Qno' => ['title' => '队列号，如1000', 'description' => '队列号，如1000', 'type' => 'string', 'example' => '1000'], + 'RecordFile' => [ + 'title' => '通话记录录音数组', + 'description' => '通话记录录音数组', + 'type' => 'array', + 'items' => [ + 'description' => '通话录音数据', + 'type' => 'object', + 'properties' => [ + 'Monitor_type' => ['title' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'description' => '1. 混音 2. 分线录音（保留2个单声道WAV） 3.留言 5. 分线录音（保留1个双声道WAV）', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Type' => ['title' => '取值：record,voicemail说明：record是录音， voicemail是留言', 'description' => '取值：record,voicemail说明：record是录音， voicemail是留言', 'type' => 'string', 'example' => 'record'], + 'File' => ['title' => '录音文件名', 'description' => '录音文件名', 'type' => 'string', 'example' => ' name3'], + ], + ], + 'example' => '', + ], + 'CustomerNumber' => ['title' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'description' => '客户号码 国内固话或手机，区号 + 7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。如 01041005968或18701051984 或虚拟号-分机号场景格式，如 18701051984-7538', 'type' => 'string', 'example' => '18701051984'], + 'CalleeRingingTime' => ['title' => '客户响铃时间，时间戳，精确到s，如1480904471', 'description' => '客户响铃时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822302'], + 'AgentName' => ['description' => '座席名称', 'type' => 'string', 'example' => '张三'], + 'DownGrade' => ['description' => '是否呼叫降级，0-否，1-是', 'type' => 'string', 'example' => '0'], + 'IvrName' => ['title' => 'IVR名称，默认自定义', 'description' => 'IVR名称，默认自定义', 'type' => 'string', 'example' => 'webcall'], + 'Status' => ['title' => '外呼结果， 如客户接听', 'description' => '外呼结果， 如客户接听', 'type' => 'string', 'example' => '客户接听'], + 'UniqueId' => ['title' => '电话唯一标识', 'description' => '电话唯一标识', 'type' => 'string', 'example' => 'uniq_1-162046xxxx.12'], + 'SipCause' => ['title' => '号码状态识别编码，详见', 'description' => '号码状态识别编码，详见', 'type' => 'string', 'example' => '200'], + 'CustomerCity' => ['title' => '客户号码归属城市,北京', 'description' => '客户号码归属城市,北京', 'type' => 'string', 'example' => '北京'], + 'CallId' => ['title' => '通话唯一标识', 'description' => '通话唯一标识', 'type' => 'string', 'example' => '4e18e73a-af6a-4a77-92ea-628a6effd64b'], + 'StartTime' => ['title' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'description' => '电话进入系统时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822302'], + 'SipCauseStr' => ['title' => '呼叫结果', 'description' => '呼叫结果', 'type' => 'string', 'example' => '处理成功'], + 'TaskFileId' => ['title' => '任务文件id', 'description' => '任务文件id', 'type' => 'string', 'example' => '12144'], + 'IsRealAnswer' => ['title' => '是否真人接听：1 - 是、0 - 否、空值', 'description' => '是否真人接听：1 - 是、0 - 否、空值', 'type' => 'string', 'example' => '1'], + 'DownGradeCounts' => ['description' => '呼叫降级次数', 'type' => 'string', 'example' => '0'], + 'CalleeNumber' => ['title' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'description' => '座席电话 区号 +7或8位的固话号码，区号与固话号码之间无\'-\'；或11位长度的手机号码。0104100596', 'type' => 'string', 'example' => '0104100596'], + 'TotalDuration' => ['title' => '总通话时长秒数，单位是s', 'description' => '总通话时长秒数，单位是s', 'type' => 'string', 'example' => '10'], + 'BridgeDuration' => ['title' => '服务处理时长秒数，单位是s', 'description' => '服务处理时长秒数，单位是s', 'type' => 'string', 'example' => '4'], + 'Id' => ['description' => 'Id', 'type' => 'string', 'example' => '14454'], + 'BridgeTime' => ['title' => '座席接听时间，时间戳，精确到s，如1480904471', 'description' => '座席接听时间，时间戳，精确到s，如1480904471', 'type' => 'string', 'example' => '1774822308'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取webCall通话记录', + 'summary' => '通过本接口，可以查询webCall通话记录信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"RealAnswerTime\\": \\"1775024775\\",\\n \\"NumberTrunk\\": \\"42003255\\",\\n \\"CustomerProvince\\": \\"北京\\",\\n \\"TaskId\\": \\"13354\\",\\n \\"DisplayNumber\\": \\"02138276106\\",\\n \\"EndTime\\": \\"1774822312\\",\\n \\"Clid\\": \\"02138276106\\",\\n \\"Cno\\": \\"2000\\",\\n \\"TrunkGroupKey\\": \\"30019\\",\\n \\"CalleeDisplayNumber\\": \\"02138276106\\",\\n \\"DetailRingingTime\\": \\"1774822303\\",\\n \\"CallType\\": \\"webcall\\",\\n \\"Gno\\": \\"WH333\\",\\n \\"AnswerTime\\": \\"1774822302\\",\\n \\"StatusCode\\": \\"24\\",\\n \\"RequestUniqueId\\": \\"214b76605a43d02f4aab4e61cfa63128\\",\\n \\"CalleeClid\\": \\"02138276106\\",\\n \\"WaitDuration\\": \\"6\\",\\n \\"EndReason\\": \\"1000\\",\\n \\"Qno\\": \\"1000\\",\\n \\"RecordFile\\": [\\n {\\n \\"Monitor_type\\": 1,\\n \\"Type\\": \\"record\\",\\n \\"File\\": \\" name3\\"\\n }\\n ],\\n \\"CustomerNumber\\": \\"18701051984\\",\\n \\"CalleeRingingTime\\": \\"1774822302\\",\\n \\"AgentName\\": \\"张三\\",\\n \\"DownGrade\\": \\"0\\",\\n \\"IvrName\\": \\"webcall\\",\\n \\"Status\\": \\"客户接听\\",\\n \\"UniqueId\\": \\"uniq_1-162046xxxx.12\\",\\n \\"SipCause\\": \\"200\\",\\n \\"CustomerCity\\": \\"北京\\",\\n \\"CallId\\": \\"4e18e73a-af6a-4a77-92ea-628a6effd64b\\",\\n \\"StartTime\\": \\"1774822302\\",\\n \\"SipCauseStr\\": \\"处理成功\\",\\n \\"TaskFileId\\": \\"12144\\",\\n \\"IsRealAnswer\\": \\"1\\",\\n \\"DownGradeCounts\\": \\"0\\",\\n \\"CalleeNumber\\": \\"0104100596\\",\\n \\"TotalDuration\\": \\"10\\",\\n \\"BridgeDuration\\": \\"4\\",\\n \\"Id\\": \\"14454\\",\\n \\"BridgeTime\\": \\"1774822308\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudStartTask' => [ + 'summary' => '手动启动外呼任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8001654'], + ], + [ 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['title' => '外呼任务id', 'description' => '外呼任务id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '32'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID，成功下发机器人外呼任务后返回。可以在语音控制台[任务管理](https://dyvms.console.aliyun.com/job/list)中查看，或调用接口**BatchRobotSmartCall**成功后记录返回的参数**TaskId**。', - 'type' => 'string', - 'required' => true, - 'example' => '4001112222', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], + 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果 0-成功，1-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动呼叫任务', + 'description' => '启动预测外呼任务'."\n" + ."\n" + .'1个企业最多有10个在运行或暂停状态的任务；'."\n" + ."\n" + .'1个座席只能在1个运行或暂停的任务中;'."\n" + ."\n" + .'任务中默认至少10个可用座席（不包含置忙的座席），否则任务启动后会自动暂停；'."\n" + ."\n" + .'任务运行过程中，座席平均接听时延需要小于2秒，否则任务将会自动结束；'."\n" + ."\n" + .'任务运行过程中，接通率过低，任务会自动结束；', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudUnassignAgentGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'QueryDate', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', 'in' => 'query', - 'schema' => [ - 'description' => '机器人外呼任务的开始时间。Unix时间戳格式，单位为毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2020-10-09 09:02:03', - ], + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], ], [ - 'name' => 'Callee', + 'name' => 'Gno', 'in' => 'query', + 'schema' => ['title' => '外呼组编号；说明：解除此gno对应外呼组 与 cno对应座席 的绑定关系', 'description' => '外呼组编号；说明：解除此gno对应外呼组 与 cno对应座席 的绑定关系', 'type' => 'string', 'required' => true, 'example' => 'WH123'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席编号；说明：解除此cno对应座席 与 gno对应外呼组 的绑定关系', 'description' => '座席编号；说明：解除此cno对应座席 与 gno对应外呼组 的绑定关系', 'type' => 'string', 'required' => true, 'example' => '12221'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '被叫号码。当前仅支持查看一个被叫号码的外呼记录。', - 'type' => 'string', - 'required' => true, - 'example' => '1390000****', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '废弃参数可忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '0-成功，其它-失败', 'description' => '0-成功，其它-失败', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '解绑外呼组', + 'summary' => '通过本接口，可以清除外呼组与座席的绑定关系。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudUpdateAgent' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Cno', + 'in' => 'query', + 'schema' => ['title' => '座席工号；正整数，取值3-10位数字', 'description' => '座席工号；正整数，取值3-10位数字', 'type' => 'string', 'required' => true, 'example' => '1111'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'description' => '座席姓名；需进行UTF-8格式的URLEncode编码', 'type' => 'string', 'required' => false, 'example' => '张三'], + ], + [ + 'name' => 'AreaCode', + 'in' => 'query', + 'schema' => ['title' => '座席所属区号；区号格式', 'description' => '座席所属区号', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'Active', + 'in' => 'query', + 'schema' => ['title' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'description' => '是否激活；取值0或1，取值说明 0：不激活，1激活，默认激活', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => ['title' => '座席类型；取值1或2，取值说明 1：电话座席，2：电脑座席，默认电话座席', 'description' => '座席类型；取值1或2，取值说明 1：电话座席，2：电脑座席，默认电话座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Power', + 'in' => 'query', + 'schema' => ['title' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'description' => '座席权限；取值1或0，取值说明 1：班长席，0：普通座席，默认为0 普通座席', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallPower', + 'in' => 'query', + 'schema' => ['title' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限；取值说明 0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '整理时间；单位秒数，默认10秒', 'description' => '整理时间；单位秒数，默认10秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '22'], + ], + [ + 'name' => 'IsOb', + 'in' => 'query', + 'schema' => ['title' => '是否允许外呼；取值说明 0：不允许，1：可以，默认允许', 'description' => '是否允许外呼；取值说明 0：不允许，1：允许，默认允许', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidType', + 'in' => 'query', + 'schema' => ['title' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'description' => '外显规则；取值：1:默认 2:随机 3:按区号 4 动态外显 ，默认值为1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClid', + 'in' => 'query', + 'schema' => ['title' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'description' => '透传号码；可传入企业中继号码或设置好的客户侧外显号码，当obClidType值为2或3时必选', 'type' => 'string', 'required' => false, 'example' => '22223333'], + ], + [ + 'name' => 'IsRandom', + 'in' => 'query', + 'schema' => ['title' => '随机外显；取值说明 0:否，1:是。当obClidType值为4时需要传值，默认值为0', 'description' => '随机外显；取值说明 0:否，1:是。当obClidType值为4时需要传值，默认值为0', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号（注意：json格式数据需要URLencode）', 'description' => '外显属性；取值：{"isMatchCapital":0,"areaCodeRule":1}；obClidType=4时，isMatchCapital表示是否匹配省会号码，1是 0否，areaCodeRule表示区号匹配规则，1座席区号 2客户号码区号（注意：json格式数据需要URLencode）', 'type' => 'string', 'required' => false, 'example' => '{"isMatchCapital":0,"areaCodeRule":1}'], + ], + [ + 'name' => 'IbRecord', + 'in' => 'query', + 'schema' => ['title' => '呼入是否录音；取值说明 0：不录用，1：录音，默认录音', 'description' => '呼入是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ObRecord', + 'in' => 'query', + 'schema' => ['title' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'description' => '外呼是否录音；取值说明 0：不录音，1：录音，默认录音', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SkillIds', + 'in' => 'query', + 'schema' => ['title' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；skillIds为"0"时代表清空座席所有技能，不为"0"时需要同时传入skillLevels', 'description' => '所选的技能id；可选择多个，多个之间使用英文标点逗号间隔.例如:"1,2,3"；skillIds为"0"时代表清空座席所有技能，不为"0"时需要同时传入skillLevels', 'type' => 'string', 'required' => false, 'example' => '1,2,3'], + ], + [ + 'name' => 'SkillLevels', + 'in' => 'query', + 'schema' => ['title' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'description' => '所选的技能的等级；值越小技能越高，多个间用英文标点逗号间隔。(与技能id相对应) 例如:"5,1,1"表示技能id为1的等级是5; 技能id为2的等级是1; 技能id为3的等级是1.', 'type' => 'string', 'required' => false, 'example' => '5,1,1'], + ], + [ + 'name' => 'IsAsr', + 'in' => 'query', + 'schema' => ['title' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写；取值说明：0：不开启，1：开启，默认不开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsQualityCheck', + 'in' => 'query', + 'schema' => ['title' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'description' => '是否开启座席质检；取值说明：0：不开启，1：开启，默认开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'WebrtcUrlType', + 'in' => 'query', + 'schema' => ['title' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址；取值说明：0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IsObRemember', + 'in' => 'query', + 'schema' => ['title' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'description' => '外呼主叫记忆开关；取值说明：0：关闭 1：开启；默认开启', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '示例值'], + ], + [ + 'name' => 'PermitObPreviewTime', + 'in' => 'query', + 'schema' => ['title' => '可外呼时间段；格式：08:00,20:00', 'description' => '可外呼时间段；格式：08:00,20:00', 'type' => 'string', 'required' => false, 'example' => '08:00,20:00'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], + 'AccessDeniedDetail' => ['description' => '请求失败详情。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => '响应信息', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '机器人外呼任务的话单详情，JSON格式。参数包括：'."\n" - .'- **startDate**：应答时间。'."\n" - .'- **stateDesc**：挂机原因，有早媒体状态码的情况下，使用早媒体码的原因。'."\n" - .'- **statusCode**：状态码。'."\n" - .'- **endDate**：结束时间。'."\n" - .'- **calleeShowNumber**：主叫号显。'."\n" - .'- **callee**：被叫号码。'."\n" - .'- **duration**：计费时长。'."\n" - .'- **gmtCreate**：创建时间。'."\n" - .'- **hangupDirection**：挂机方向。'."\n" - .'- **tags**：标签。'."\n" - .'- **dialogCount**：对话轮次。'."\n" - .'- **sureCount**：肯定次数。'."\n" - .'- **denyCount**：否定次数。'."\n" - .'- **rejectCount**：拒绝次数。'."\n" - .'- **customCount**：自定义次数。'."\n" - .'- **knowledgeCount**：知识库次数。'."\n" - .'- **recordFile**：录音文件下载地址，URL的过期时间为48小时，请及时下载。'."\n" - .'- **callId**：通话ID。'."\n" - .'- **recordStatus**：录音文件状态。其中：'."\n" - .' - 1：有录音文件。'."\n" - .' - 2：没有录音文件。'."\n" - .'- **knowledgeCommonCount**：知识库通用问题字数。'."\n" - .'- **knowledgeBusinessCount**：知识库业务问题字数。'."\n" - .'- **callee**：被叫号码。'."\n" - .'- **dialogDetail**：对话明细，一个JSON数组。其中包括：'."\n" - .' - **role**：发言对象。'."\n" - .' - **content**：发言内容。'."\n" - .' - **time**：发言时间。'."\n" - ."\n" - .'> 返回字段供参考，具体字段以实际返回参数为准。', - 'type' => 'string', - 'example' => '{"rejectCount":0,"dialogCount":3,"tags":"","startDate":"2019-03-27 10:34:54","gmtCreate":"2019-03-27 10:34:40","sureCount":0,"state":"200000","recordFile":"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQuk%3D&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"1390000****","customCount":0,"callId":"1390000****","knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"1390000****","knowledgeBusinessCount":0,"hangupDirection":1}'."\n", - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D86B61A8-F2EE-4E4C-9F05-08A4676FFD89', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'title' => '座席配置信息', + 'description' => '座席配置信息', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '座席状态，0:离线，1：在线', 'description' => '座席状态，0:离线，1：在线', 'type' => 'string', 'example' => '0'], + 'IsQualityCheck' => ['description' => '是否开启座席质检，取值说明：0：不开启，1：开启，默认开启', 'type' => 'string', 'example' => '1'], + 'CallPower' => ['title' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'description' => '呼叫权限，0：无限制，1：国内长途，2：国内本市，3：内部呼叫，默认无限制', 'type' => 'string', 'example' => '1'], + 'ObClid' => ['title' => '外显号码', 'description' => '外显号码', 'type' => 'string', 'example' => '22223333'], + 'Cno' => ['title' => '座席工号', 'description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'IbRecord' => ['title' => '呼入是否录音，0：不录用，1：录音，默认录音', 'description' => '呼入是否录音，0：不录用，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'BindTelType' => ['title' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'description' => '电话类型，1:固话 2:手机 3:分机 4:软电话', 'type' => 'string', 'example' => '1'], + 'Wrapup' => ['title' => '整理时间，秒数，默认10秒', 'description' => '整理时间，秒数，默认10秒', 'type' => 'string', 'example' => '22'], + 'ObRecord' => ['title' => '外呼是否录音，0：不录音，1：录音，默认录音', 'description' => '外呼是否录音，0：不录音，1：录音，默认录音', 'type' => 'string', 'example' => '1'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + 'Name' => ['title' => '座席姓名', 'description' => '座席姓名', 'type' => 'string', 'example' => '张三'], + 'IsAsr' => ['title' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'description' => '是否开启ASR转写：0：不开启，1：开启，默认不开启', 'type' => 'string', 'example' => '1'], + 'AgentType' => ['title' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'description' => '座席类型，1：电话座席，2：电脑座席，默认电话座席', 'type' => 'string', 'example' => '1'], + 'Active' => ['title' => '是否启用，0：停用，1：启用，默认启用', 'description' => '是否启用，0：停用，1：启用，默认启用', 'type' => 'string', 'example' => '1'], + 'ObClidType' => ['title' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'description' => '外显规则 1：企业默认 2：随机 3：按区号 4：动态外显', 'type' => 'string', 'example' => '1'], + 'WebrtcUrlType' => ['title' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'description' => 'webrtc软电话返回地址，0：企业默认 1：公网域名 2：专线域名 3：公网IP 4：专线IP', 'type' => 'string', 'example' => '1'], + 'AreaCode' => ['title' => '区号格式', 'description' => '区号', 'type' => 'string', 'example' => '010'], + 'ObClidProperty' => ['title' => '外显规则属性，JSON格式', 'description' => '外显规则属性，JSON格式', 'type' => 'string', 'example' => '{"isMatchCapital":0,"areaCodeRule":1}'], + 'BindTel' => ['title' => '座席绑定电话', 'description' => '座席绑定电话', 'type' => 'string', 'example' => '22223333'], + 'Id' => ['title' => '座席id', 'description' => '座席id', 'type' => 'string', 'example' => '100012'], + 'Power' => ['title' => '1：班长席，0：普通座席，默认普通座席', 'description' => '1：班长席，0：普通座席，默认普通座席', 'type' => 'string', 'example' => '1'], + 'IsOb' => ['title' => '是否允许外呼，0：不允许，1：可以，默认允许', 'description' => '是否允许外呼，0：不允许，1：允许，默认允许', 'type' => 'string', 'example' => '1'], + ], + 'example' => '', + ], + 'AgentSkills' => [ + 'title' => '座席所需技能数组', + 'description' => '座席技能数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillLevel' => ['title' => '技能值', 'description' => '技能值', 'type' => 'string', 'example' => '2'], + 'Cno' => ['description' => '座席工号', 'type' => 'string', 'example' => '1111'], + 'CreateTime' => ['title' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'description' => '创建时间，格式: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-04-20 10:00:00'], + 'SkillId' => ['title' => 'skill的id', 'description' => 'skill的id', 'type' => 'string', 'example' => '111'], + 'Id' => ['title' => 'queueSkill关系表中id', 'description' => 'queueSkill关系表中id', 'type' => 'string', 'example' => '123'], + 'AgentId' => ['title' => '座席id', 'description' => '座席id', 'type' => 'string', 'example' => '1234'], + 'EnterpriseId' => ['title' => '企业编号', 'description' => '企业编号', 'type' => 'string', 'example' => '7000002'], + ], + 'description' => '', + ], + 'example' => '', + ], + ], ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO)。', 'type' => 'string', 'example' => 'OK'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"rejectCount\\\\\\":0,\\\\\\"dialogCount\\\\\\":3,\\\\\\"tags\\\\\\":\\\\\\"\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"2019-03-27 10:34:54\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2019-03-27 10:34:40\\\\\\",\\\\\\"sureCount\\\\\\":0,\\\\\\"state\\\\\\":\\\\\\"200000\\\\\\",\\\\\\"recordFile\\\\\\":\\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQuk%3D&Expires=1554382725\\\\\\",\\\\\\"defaultCount\\\\\\":0,\\\\\\"endDate\\\\\\":\\\\\\"2019-03-27 10:35:09\\\\\\",\\\\\\"calleeShowNumber\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"customCount\\\\\\":0,\\\\\\"callId\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"knowledgeCount\\\\\\":0,\\\\\\"recordStatus\\\\\\":1,\\\\\\"denyCount\\\\\\":0,\\\\\\"duration\\\\\\":16,\\\\\\"knowledgeCommonCount\\\\\\":0,\\\\\\"callee\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"knowledgeBusinessCount\\\\\\":0,\\\\\\"hangupDirection\\\\\\":1}\\\\n\\",\\n \\"RequestId\\": \\"D86B61A8-F2EE-4E4C-9F05-08A4676FFD89\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryCallDetailByTaskIdResponse>\\r\\n \\t<Data>{"rejectCount":0,"dialogCount":3,"tags":1,"startDate":"2019-03-27 10:34:54","gmtCreate":"2019-03-27 10:34:40","sureCount":0,"state":"200000","recordFile":"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQu****&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"053158552960","customCount":0,"callId":"115987800002^102789420002","dialogDetail":[{"content":"我的呼叫测试","startTime":"Wed Mar 27 10:34:45 CST 2019","role":"robot"},{"content":"喂，哎，你好","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"custom"},{"content":"不好意思，可以慢点再说一遍吗?","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"robot"},{"content":"喂","startTime":"Wed Mar 27 10:35:01 CST 2019","role":"custom"},{"content":"哦再见","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"custom"},{"content":"不好意思，我这边听得不是很清楚，您可以再说一遍吗？","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"robot"}],"knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"13735460951","knowledgeBusinessCount":0,"hangupDirection":1}</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D86B61A8-F2EE-4E4C-9F05-08A4676FFD89</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryCallDetailByTaskIdResponse>","errorExample":""}]', - 'title' => '查看指定机器人外呼任务的话单详情', - 'summary' => '查看指定机器人外呼任务的话单详情。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '座席更新', + 'summary' => '更新座席基础信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Agent\\": {\\n \\"Status\\": \\"0\\",\\n \\"IsQualityCheck\\": \\"1\\",\\n \\"CallPower\\": \\"1\\",\\n \\"ObClid\\": \\"22223333\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"IbRecord\\": \\"1\\",\\n \\"BindTelType\\": \\"1\\",\\n \\"Wrapup\\": \\"22\\",\\n \\"ObRecord\\": \\"1\\",\\n \\"EnterpriseId\\": \\"7000002\\",\\n \\"Name\\": \\"张三\\",\\n \\"IsAsr\\": \\"1\\",\\n \\"AgentType\\": \\"1\\",\\n \\"Active\\": \\"1\\",\\n \\"ObClidType\\": \\"1\\",\\n \\"WebrtcUrlType\\": \\"1\\",\\n \\"AreaCode\\": \\"010\\",\\n \\"ObClidProperty\\": \\"{\\\\\\"isMatchCapital\\\\\\":0,\\\\\\"areaCodeRule\\\\\\":1}\\",\\n \\"BindTel\\": \\"22223333\\",\\n \\"Id\\": \\"100012\\",\\n \\"Power\\": \\"1\\",\\n \\"IsOb\\": \\"1\\"\\n },\\n \\"AgentSkills\\": [\\n {\\n \\"SkillLevel\\": \\"2\\",\\n \\"Cno\\": \\"1111\\",\\n \\"CreateTime\\": \\"2026-04-20 10:00:00\\",\\n \\"SkillId\\": \\"111\\",\\n \\"Id\\": \\"123\\",\\n \\"AgentId\\": \\"1234\\",\\n \\"EnterpriseId\\": \\"7000002\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], - 'QueryRobotTaskDetail' => [ - 'methods' => [ - 'post', - 'get', + 'CloudUpdateTask' => [ + 'summary' => '修改外呼任务的基础信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['title' => '外呼任务Id', 'description' => '外呼任务Id', 'type' => 'string', 'required' => true, 'example' => '133224'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '任务名称；需进行UTF-8格式的URLEncode编码，长度小于50字', 'description' => '任务名称；需进行UTF-8格式的URLEncode编码，长度小于50字', 'type' => 'string', 'required' => false, 'example' => '任务名称-1'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['title' => '任务描述；需进行UTF-8格式的URLEncode编码，长度小于200字', 'description' => '任务描述；需进行UTF-8格式的URLEncode编码，长度小于200字', 'type' => 'string', 'required' => false, 'example' => '描述任务信息'], + ], + [ + 'name' => 'AutoStart', + 'in' => 'query', + 'schema' => ['title' => '定时开始；0.关闭 1.开启，默认关闭。值为1时autoStartDay和autoStartTime参数才生效，并且至少设置其中的一个', 'description' => '定时开始；0.关闭 1.开启，默认关闭。值为1时autoStartDay和autoStartTime参数才生效，并且至少设置其中的一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoStartDay', + 'in' => 'query', + 'schema' => ['title' => '定时开始日期；autoStart=1时生效。参数不传入时默认在当天的autoStartTime定时启动。格式：yyyy-MM-dd，如：2017-01-01', 'description' => '定时开始日期；autoStart=1时生效。参数不传入时默认在当天的autoStartTime定时启动。格式：yyyy-MM-dd，如：2026-01-01', 'type' => 'string', 'required' => false, 'example' => '2026-01-01'], + ], + [ + 'name' => 'AutoStartTime', + 'in' => 'query', + 'schema' => ['title' => '定时开始时间；autoStart=1时生效。参数不传入时默认在autoStartDay的00:00:00定时启动。格式：HH:mm:ss，如：08:00:00', 'description' => '定时开始时间；autoStart=1时生效。参数不传入时默认在autoStartDay的00:00:00定时启动。格式：HH:mm:ss，如：08:00:00', 'type' => 'string', 'required' => false, 'example' => '08:00:00'], + ], + [ + 'name' => 'AutoStop', + 'in' => 'query', + 'schema' => ['title' => '定时完成；0.关闭 1.开启，默认关闭。值为1时autoStopDay和autoStopTime参数才生效，并且至少设置其中的一个', 'description' => '定时完成；0.关闭 1.开启，默认关闭。值为1时autoStopDay和autoStopTime参数才生效，并且至少设置其中的一个', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoStopDay', + 'in' => 'query', + 'schema' => ['title' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2017-01-01', 'description' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2026-01-01', 'type' => 'string', 'required' => false, 'example' => '定时完成日期；autoStop=1时生效。参数不传入时默认在当天的autoStopTime定时完成。格式：yyyy-MM-dd，如：2026-01-01'], + ], + [ + 'name' => 'AutoStopTime', + 'in' => 'query', + 'schema' => ['title' => '定时完成时间；autoStop=1时生效。参数不传入时默认在autoStopDay的23:59:59定时完成。格式：HH:mm:ss，如：17:00:00', 'description' => '定时完成时间；autoStop=1时生效。参数不传入时默认在autoStopDay的23:59:59定时完成。格式：HH:mm:ss，如：17:00:00', 'type' => 'string', 'required' => false, 'example' => '17:00:00'], + ], + [ + 'name' => 'ForceEndFlag', + 'in' => 'query', + 'schema' => ['title' => '定时完成时强制结束任务；autoStop=1时生效。0.关闭 1.开启，默认关闭。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'description' => '定时完成时强制结束任务；autoStop=1时生效。0.关闭 1.开启，默认关闭。开启配置后，当任务到定时完成时间时无论任务中的号码是否已经呼完，均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注：任务在结束状态时无法再次启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoTaskType', + 'in' => 'query', + 'schema' => ['title' => '0.连续呼叫 1.间隔呼叫，默认连续呼叫。配合定时开始（autoStart）和定时结束（autoStop）参数使用，如任务需要在每天的特定时间段内呼叫则开启间隔呼叫方式', 'description' => '0.连续呼叫 1.间隔呼叫，默认连续呼叫。配合定时开始（autoStart）和定时结束（autoStop）参数使用，如任务需要在每天的特定时间段内呼叫则开启间隔呼叫方式', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'AutoTriggerTimeStrategy', + 'in' => 'query', + 'schema' => ['title' => '间隔呼叫时间段；autoTaskType=1时必填。呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'description' => '间隔呼叫时间段；autoTaskType=1时必填。呼叫的时间段配置。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'type' => 'string', 'required' => false, 'example' => '9,22'], + ], + [ + 'name' => 'AutoComplete', + 'in' => 'query', + 'schema' => ['title' => '0.关闭 1.开启，默认开启。开启：任务中的号码呼叫完后，任务自动完成，状态设置为结束，关闭：任务中的号码呼叫完后，任务自动暂停，状态设置为暂停注：任务在结束状态时无法再次启动。', 'description' => '0.关闭 1.开启，默认开启。开启：任务中的号码呼叫完后，任务自动完成，状态设置为结束，关闭：任务中的号码呼叫完后，任务自动暂停，状态设置为暂停注：任务在结束状态时无法再次启动。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RetryStrategy', + 'in' => 'query', + 'schema' => ['title' => '重试策略；「基础模式」数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟「高级模式」高级模式需要开启「号码状态识别」服务数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致 注：基础模式和高级模式的区分根据传入的参数格式自动识别。基于首次呼叫时间重试时，每轮的重试时间必须大于上一轮的时间', 'description' => '重试策略；「基础模式」数据结构为Json格式```{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}```格式说明：retry是重试次数，round是第几次重试，time是第几次重试间隔的时间：1-1-1，第一个1是天，第二个1是小时，第三个1是分钟「高级模式」高级模式需要开启「号码状态识别」服务数据结构为JsonArray格式 ```[{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]```格式说明：condition是重试条件，sort是重试条件的顺序，其余字段与基础模式一致 注：基础模式和高级模式的区分根据传入的参数格式自动识别。基于首次呼叫时间重试时，每轮的重试时间必须大于上一轮的时间', 'type' => 'string', 'required' => false, 'example' => '{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}'], + ], + [ + 'name' => 'RetryStrategyTimeType', + 'in' => 'query', + 'schema' => ['title' => '重试策略时间类型；配置重试策略时生效。 1.基于首次呼叫时间 2.基于上次呼叫时间，默认基于首次呼叫时间', 'description' => '重试策略时间类型；配置重试策略时生效。 1.基于首次呼叫时间 2.基于上次呼叫时间，默认基于首次呼叫时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RetryStrategyOnlyToday', + 'in' => 'query', + 'schema' => ['title' => '任务仅当天生效；0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据，默认关闭', 'description' => '任务仅当天生效；0.关闭 1.开启，删除待重试的数据和待呼叫的数据 2.开启，删除待重试的数据 3.开启，删除待呼叫的数据，默认关闭', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CallPriorityStrategy', + 'in' => 'query', + 'schema' => ['title' => '数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```格式说明：sort是重试号码和未呼叫号码的呼叫顺序 type：retryCall重试号码、firstCall未呼叫号码当type=retryCall，desc：0.优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫 1.优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫当type=firstCall时，orderType：随机呼叫，0顺序(优先级) 1随机 2顺序(导入时间)', 'description' => '数据结构为Json格式```{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}```格式说明：sort是重试号码和未呼叫号码的呼叫顺序 type：retryCall重试号码、firstCall未呼叫号码当type=retryCall，desc：0.优先呼叫待重呼轮次数值较小的号码，即轮次靠前（如第1轮、第2轮）的号码先被呼叫 1.优先呼叫待重呼轮次数值较大的号码，即轮次靠后（如第5轮、第4轮）的号码先被呼叫当type=firstCall时，orderType：随机呼叫，0顺序(优先级) 1随机 2顺序(导入时间)', 'type' => 'string', 'required' => false, 'example' => '{"strategy":[{"sort":1,"type":"retryCall", "desc":0},{"sort":2,"type":"firstCall","orderType":0}]}'], + ], + [ + 'name' => 'CustomerClidsCategory', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码类型；1.外显固话 2.外显手机号 4.外显号码池 5.外显导航注：推荐使用外显导航，可以灵活调整和控制外显策略。其他类型将逐步下线', 'description' => '客户侧外显号码类型；1.外显固话 2.外显手机号 4.外显号码池 5.外显导航注：推荐使用外显导航，可以灵活调整和控制外显策略。其他类型将逐步下线', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CustomerClids', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码列表；customerClidsCategory=1或2时必填。支持多个，多个直接使用英文逗号\',\'分隔。不建议使用', 'description' => '客户侧外显号码列表；customerClidsCategory=1或2时必填。支持多个，多个直接使用英文逗号\',\'分隔。不建议使用', 'type' => 'string', 'required' => false, 'example' => '64203667,23434294'], + ], + [ + 'name' => 'CustomerClidType', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显规则；customerClidsCategory=1或2时生效。1.随机 2.按区号，默认随机。不建议使用', 'description' => '客户侧外显规则；customerClidsCategory=1或2时生效。1.随机 2.按区号，默认随机。不建议使用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ClidProperty', + 'in' => 'query', + 'schema' => ['title' => '外显规则；customerClidType=2时生效。Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}。不建议使用', 'description' => '外显规则；customerClidType=2时生效。Json格式，外显号码选择规则：默认区号，是否匹配省会等；如：{"defaultAreaCode":"010", "isMatchCapital":"1"}。不建议使用', 'type' => 'string', 'required' => false, 'example' => '{"defaultAreaCode":"010", "isMatchCapital":"1"}'], + ], + [ + 'name' => 'CustomerClidWeightFlag', + 'in' => 'query', + 'schema' => ['title' => '外显号码比例配置开关；customerClidsCategory=1时生效。0.关闭 1.开启，默认关闭。不建议使用', 'description' => '外显号码比例配置开关；customerClidsCategory=1时生效。0.关闭 1.开启，默认关闭。不建议使用', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'CustomerClidWeight', + 'in' => 'query', + 'schema' => ['title' => '外显号码比例配置内容；customerClidsCategory=1且customerClidWeightFlag=1时生效。JsonArray格式 [{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]，不建议使用', 'description' => '外显号码比例配置内容；customerClidsCategory=1且customerClidWeightFlag=1时生效。JsonArray格式 [{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]，不建议使用', 'type' => 'string', 'required' => false, 'example' => '[{"number":"123,345","weight":"5"}, {"number":"567,789","weight":"5"}]'], + ], + [ + 'name' => 'CustomerClidsGroup', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码池名称或外显导航标识；customerClidsCategory=4或5时必填。customerClidsCategory=4时customerClidsGroup传号码池名称。customerClidsCategory=5时customerClidsGroup传外显导航标识', 'description' => '客户侧外显号码池名称或外显导航标识；customerClidsCategory=4或5时必填。customerClidsCategory=4时customerClidsGroup传号码池名称。customerClidsCategory=5时customerClidsGroup传外显导航标识', 'type' => 'string', 'required' => false, 'example' => '示例值'], + ], + [ + 'name' => 'CustomerTimeout', + 'in' => 'query', + 'schema' => ['title' => '客户超时时间；单位秒数，默认30秒，取值范围5 ~ 60', 'description' => '客户超时时间；单位秒数，默认30秒，取值范围5 ~ 60', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55'], + ], + [ + 'name' => 'CallRouteStrategy', + 'in' => 'query', + 'schema' => ['title' => '1.直连座席 2.AI转人工 直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验 AI转人工：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本', 'description' => '1.直连座席 2.AI转人工 直连座席模式：客户接听后直接分配座席，无空闲座席可溢出语音导航（需配置语音导航），保障高优先级客户直连体验 AI转人工：客户接入后，优先进入语音导航中配置的智能体机器人，按交互结果决定是否转接座席，提升自动化覆盖率，降低人工成本', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['title' => '语音导航Id；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。预测外呼使用场景：如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效自动外呼使用场景：客户接听后，转到的语音导航', 'description' => '语音导航Id；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。预测外呼使用场景：如果客户接听后未在特定时间内（默认2秒）找到可用座席，通话将溢出到语音导航继续排队找座席。同时支持在呼转座席，座席未接听时也溢出到语音导航，需要开启企业配置生效自动外呼使用场景：客户接听后，转到的语音导航', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13'], + ], + [ + 'name' => 'IvrName', + 'in' => 'query', + 'schema' => ['title' => '语音导航名称；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。', 'description' => '语音导航名称；参数ivrId和ivrName二选一，同时传入时ivrId生效，在创建自动外呼任务时ivrId或ivrName必选其一。', 'type' => 'string', 'required' => false, 'example' => 'IvrName1'], + ], + [ + 'name' => 'Concurrency', + 'in' => 'query', + 'schema' => ['title' => '任务维度限制最大并发数，实际并发不会超过最大并发限制。type=1时，配置成0表示不限制，座席数量少于10时建议配置该参数', 'description' => '任务维度限制最大并发数，实际并发不会超过最大并发限制。type=1时，配置成0表示不限制，座席数量少于10时建议配置该参数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'UserFields', + 'in' => 'query', + 'schema' => ['title' => '任务自定义字段。JsonArray格式；数组的每个元素只支持传递一组键值对，传递多组只取第一组，如 {"key", "value"}。 默认空值，示例：[{"name":"1234"},{"name1":"12345"}] 注：单个字段值的长度不能超过1000个字符', 'description' => '任务自定义字段。JsonArray格式；数组的每个元素只支持传递一组键值对，传递多组只取第一组，如 {"key", "value"}。 默认空值，示例：[{"name":"1234"},{"name1":"12345"}] 注：单个字段值的长度不能超过1000个字符', 'type' => 'string', 'required' => false, 'example' => '[{"name":"1234"},{"name1":"12345"}] '], + ], + [ + 'name' => 'CallVariables', + 'in' => 'query', + 'schema' => ['title' => '座席通道变量。JsonArray格式；最大支持5个变量。默认空值， 示例：[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] 注：单个字段值的长度不能超过1000个字符。变量会以SIP_HEADER的形式设置到座席侧通道', 'description' => '座席通道变量。JsonArray格式；最大支持5个变量。默认空值， 示例：[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] 注：单个字段值的长度不能超过1000个字符。变量会以SIP_HEADER的形式设置到座席侧通道', 'type' => 'string', 'required' => false, 'example' => '[{"name":"abcdefg","value":"${cdr_enterprise_id}"}] '], + ], + [ + 'name' => 'TimeStrategy', + 'in' => 'query', + 'schema' => ['title' => '禁呼时间；在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'description' => '禁呼时间；在特定的时间段内禁止呼叫。参数格式：时间条件编号。支持多个，多个使用英文","逗号隔开，如：9,22。注：时间条件列表可通过查询时间条件设置列表接口获取', 'type' => 'string', 'required' => false, 'example' => '9,22'], + ], + [ + 'name' => 'Cnos', + 'in' => 'query', + 'schema' => ['title' => '座席工号列表；callGroupType=1时必填。支持多个座席工号，多个之间使用英文逗号\',\'分隔注：一个座席只能在一个运行中的任务中', 'description' => '座席工号列表；callGroupType=1时必填。支持多个座席工号，多个之间使用英文逗号\',\'分隔注：一个座席只能在一个运行中的任务中', 'type' => 'string', 'required' => false, 'example' => '1111,2222'], + ], + [ + 'name' => 'AgentGroup', + 'in' => 'query', + 'schema' => ['title' => '外呼组号；callGroupType=2时必填。注：一个外呼组可以绑定到多个任务，但只能同时运行一个任务中', 'description' => '外呼组号；callGroupType=2时必填。注：一个外呼组可以绑定到多个任务，但只能同时运行一个任务中', 'type' => 'string', 'required' => false, 'example' => '6,7'], + ], + [ + 'name' => 'CallStrategy', + 'in' => 'query', + 'schema' => ['title' => '座席分配规则；1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长），默认随机', 'description' => '座席分配规则；1.随机 2.顺序 3.座席未进线最大时（从上一次呼叫结束到当前的总时长） 4.座席状态[空闲]最长时长（座席最近一次切换为空闲状态的持续时长），默认随机', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AgentTimeout', + 'in' => 'query', + 'schema' => ['title' => '座席超时时间；单位秒数，默认10秒，取值范围5 ~ 60', 'description' => '座席超时时间；单位秒数，默认10秒，取值范围5 ~ 60', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'Wrapup', + 'in' => 'query', + 'schema' => ['title' => '座席整理时间；默认30秒，取值范围1～10800，整理时间会影响每次呼叫的个数，值越大，呼叫号码个数会减小', 'description' => '座席整理时间；默认30秒，取值范围1～10800，整理时间会影响每次呼叫的个数，值越大，呼叫号码个数会减小', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'MaxWaitTime', + 'in' => 'query', + 'schema' => ['title' => '座席最长等待时间；默认40秒，最小10，最大600，允许座席空闲的最大时间。任务执行过程中，如果座席平均空闲时间大于maxWaitTime，每次呼叫个数会增加', 'description' => '座席最长等待时间；默认40秒，最小10，最大600，允许座席空闲的最大时间。任务执行过程中，如果座席平均空闲时间大于maxWaitTime，每次呼叫个数会增加', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40'], + ], + [ + 'name' => 'MinAvailableAgentCount', + 'in' => 'query', + 'schema' => ['title' => '最小可用座席数；默认为10，取值范围1 ~ 10。任务内可用座席数小于当前值时，任务自动暂停，避免骚扰', 'description' => '最小可用座席数；默认为10，取值范围1 ~ 10。任务内可用座席数小于当前值时，任务自动暂停，避免骚扰', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Quotiety', + 'in' => 'query', + 'schema' => ['title' => '骚扰率；默认值为1，取值范围为大于0，小于等于20，支持小数，精确到小数点两位。值越小呼叫的号码越少，值越大呼叫的号码越多，座席利用率越高', 'description' => '骚扰率；默认值为1，取值范围为大于0，小于等于20，支持小数，精确到小数点两位。值越小呼叫的号码越少，值越大呼叫的号码越多，座席利用率越高', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '19.00'], + ], + [ + 'name' => 'PredictAdjust', + 'in' => 'query', + 'schema' => ['title' => '超呼率；默认值为100，取值范围50～400', 'description' => '超呼率；默认值为100，取值范围50～400', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'CallLimitStrategy', + 'in' => 'query', + 'schema' => ['title' => '座席当日接听的通话个数上限，使用方式详见下方说明；JsonArray格式 [{"cnos":["2000","2001"],"limit":"5"}] 注：使用座席当日接听数限制功能需开启企业配置，功能开启并且配置上限后系统才开始统计当日接听数', 'description' => '座席当日接听的通话个数上限，使用方式详见下方说明；JsonArray格式 [{"cnos":["2000","2001"],"limit":"5"}] 注：使用座席当日接听数限制功能需开启企业配置，功能开启并且配置上限后系统才开始统计当日接听数', 'type' => 'string', 'required' => false, 'example' => '[{"cnos":["2000","2001"],"limit":"5"}] '], + ], + [ + 'name' => 'CustomerMoh', + 'in' => 'query', + 'schema' => ['title' => '客户侧等待音；客户接听后呼叫座席，等待座席接听时播放的语音，默认为空白音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'description' => '客户侧等待音；客户接听后呼叫座席，等待座席接听时播放的语音，默认为空白音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819'], + ], + [ + 'name' => 'CustomerVoice', + 'in' => 'query', + 'schema' => ['title' => '客户侧提示音；客户接听后呼转座席前播放的语音，提示音播放完成后再找座席，默认无提示音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'description' => '客户侧提示音；客户接听后呼转座席前播放的语音，提示音播放完成后再找座席，默认无提示音。支持公共语音和企业语音，值为语音文件的path，如:60000011533526918819', 'type' => 'string', 'required' => false, 'example' => '60000011533526918819'], + ], + [ + 'name' => 'AnswerRate', + 'in' => 'query', + 'schema' => ['title' => '初始化预计客户接通率；默认50，取值范围1～100，预热阶段的呼叫，按照此接通率计算呼叫频率', 'description' => '初始化预计客户接通率；默认50，取值范围1～100，预热阶段的呼叫，按照此接通率计算呼叫频率', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'WarmUpDuration', + 'in' => 'query', + 'schema' => ['title' => '任务预热时间；默认300秒, 取值范围60 ～ 600', 'description' => '任务预热时间；默认300秒, 取值范围60 ～ 600', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '370'], + ], + [ + 'name' => 'IsRewarm', + 'in' => 'query', + 'schema' => ['title' => '暂停后重新预热；0.关闭，1开启，默认开启，任务暂停后是否需要重新预热', 'description' => '暂停后重新预热；0.关闭，1开启，默认开启，任务暂停后是否需要重新预热', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回的数据内容。', + 'type' => 'object', + 'properties' => [ + 'OverTime' => ['description' => '任务结束时间', 'type' => 'string', 'example' => '2026-01-0114:00:00'], + 'CustomerTimeout' => ['description' => '客户超时时间，单位秒', 'type' => 'string', 'example' => '5'], + 'Description' => ['description' => '任务描述。', 'type' => 'string', 'example' => '任务描述'], + 'AutoStopDay' => ['description' => '定时完成日期，格式：yyyy-MM-dd', 'type' => 'string', 'example' => '2026-02-11'], + 'AgentTimeout' => ['description' => '座席超时时间，单位秒', 'type' => 'string', 'example' => '30'], + 'EnterpriseId' => ['description' => '呼叫中心id', 'type' => 'string', 'example' => '8001654'], + 'Name' => ['description' => '任务名称。', 'type' => 'string', 'example' => '任务名称'], + 'Cnos' => ['description' => '座席工号列表', 'type' => 'string', 'example' => '1111'], + 'Concurrency' => ['description' => '最大并发限制', 'type' => 'string', 'example' => '10'], + 'CustomerClids' => ['description' => '客户侧外显号码列表', 'type' => 'string', 'example' => '42366453,74565327'], + 'AutoComplete' => ['description' => '自动完成，0.关闭 1.开启', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'AutoStart' => ['description' => '定时开始，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'AnswerRate' => ['description' => '初始化预计客户接通率', 'type' => 'string', 'example' => '55'], + 'Status' => ['description' => '任务状态，0.初始 1.运行中 2.暂停 3.结束', 'type' => 'string', 'example' => '3'], + 'CustomerMoh' => ['description' => '客户侧等待音', 'type' => 'string', 'example' => '客户侧等待音'], + 'AutoStartDay' => ['description' => '定时开始日期，格式：yyyy-MM-dd', 'type' => 'string', 'example' => '2026-02-11'], + 'UserFields' => ['description' => '任务自定义字段，JsonArray格式', 'type' => 'string', 'example' => '[{"key1":"value1"},{"key2":"value2"}]'], + 'PredictAdjust' => ['description' => '超呼率', 'type' => 'string', 'example' => '超呼率'], + 'CreateTime' => ['description' => '任务创建时间 ，格式为： yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-02-10 14:00:00'], + 'StartTime' => ['description' => '任务开始时间', 'type' => 'string', 'example' => '2026-02-10 15:00:00'], + 'AutoStop' => ['description' => '定时完成，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'Wrapup' => ['description' => '座席整理时间，单位秒', 'type' => 'string', 'example' => '5'], + 'MaxWaitTime' => ['description' => '座席最大等待时间，单位秒', 'type' => 'string', 'example' => '10'], + 'Type' => ['description' => '任务类型，1.预测外呼任务 2.自动外呼任务', 'type' => 'string', 'example' => '2'], + 'AutoStartTime' => ['description' => '定时开始时间，格式：HH:mm:ss，如：08:00:00', 'type' => 'string', 'example' => '08:00:00'], + 'IsRandom' => ['description' => '随机呼叫，0.关闭 1.开启', 'type' => 'string', 'example' => '0'], + 'AutoStopTime' => ['description' => '定时完成时间，格式：HH:mm:ss，如：17:00:00', 'type' => 'string', 'example' => '17:00:00'], + 'Id' => ['description' => '任务ID。', 'type' => 'string', 'example' => '123'], + 'IvrId' => ['description' => '语音导航Id', 'type' => 'string', 'example' => '133'], + 'Quotiety' => ['description' => '骚扰率，支持小数，精确到小数点两位', 'type' => 'string', 'example' => '0.33'], + ], + ], + 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改呼叫任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"OverTime\\": \\"2026-01-0114:00:00\\",\\n \\"CustomerTimeout\\": \\"5\\",\\n \\"Description\\": \\"任务描述\\",\\n \\"AutoStopDay\\": \\"2026-02-11\\",\\n \\"AgentTimeout\\": \\"30\\",\\n \\"EnterpriseId\\": \\"8001654\\",\\n \\"Name\\": \\"任务名称\\",\\n \\"Cnos\\": \\"1111\\",\\n \\"Concurrency\\": \\"10\\",\\n \\"CustomerClids\\": \\"42366453,74565327\\",\\n \\"AutoComplete\\": 0,\\n \\"AutoStart\\": \\"0\\",\\n \\"AnswerRate\\": \\"55\\",\\n \\"Status\\": \\"3\\",\\n \\"CustomerMoh\\": \\"客户侧等待音\\",\\n \\"AutoStartDay\\": \\"2026-02-11\\",\\n \\"UserFields\\": \\"[{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\"},{\\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\"}]\\",\\n \\"PredictAdjust\\": \\"超呼率\\",\\n \\"CreateTime\\": \\"2026-02-10 14:00:00\\",\\n \\"StartTime\\": \\"2026-02-10 15:00:00\\",\\n \\"AutoStop\\": \\"0\\",\\n \\"Wrapup\\": \\"5\\",\\n \\"MaxWaitTime\\": \\"10\\",\\n \\"Type\\": \\"2\\",\\n \\"AutoStartTime\\": \\"08:00:00\\",\\n \\"IsRandom\\": \\"0\\",\\n \\"AutoStopTime\\": \\"17:00:00\\",\\n \\"Id\\": \\"123\\",\\n \\"IvrId\\": \\"133\\",\\n \\"Quotiety\\": \\"0.33\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CloudWebcall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'EnterpriseId', + 'in' => 'query', + 'schema' => ['title' => '呼叫中心 id', 'description' => '呼叫中心 id', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7000002'], + ], + [ + 'name' => 'Tel', + 'in' => 'query', + 'schema' => ['title' => '电话号码；固话带区号，手机不加0；固话带分机的以\'-\'分隔；支持多个号码，多个直接用英文逗号’,’分隔；传多个号码时，若前面的号码没接通则会呼叫后面的号码，若接通则不会呼叫；[加密外呼](../字段定义/接口部分/加密外呼号码加密规则.md)；如果是加密的号码，需要URLEncode后传入', 'description' => '电话号码；固话带区号，手机不加0；固话带分机的以\'-\'分隔；支持多个号码，多个直接用英文逗号’,’分隔；传多个号码时，若前面的号码没接通则会呼叫后面的号码，若接通则不会呼叫；[加密外呼](../字段定义/接口部分/加密外呼号码加密规则.md)；如果是加密的号码，需要URLEncode后传入', 'type' => 'string', 'required' => true, 'example' => '13312345678'], + ], + [ + 'name' => 'RequestUniqueId', + 'in' => 'query', + 'schema' => ['title' => '请求唯一标识；说明：长度不超过300个字节。1个汉字是3字节。此字段保存到通话记录requestUniqueId字段，后续接口查询使用。一次接口请求造成的多次呼叫requestUniqueId相同；如果是加密的号码，需要URLEncode后传入', 'description' => '请求唯一标识；说明：长度不超过300个字节。1个汉字是3字节。此字段保存到通话记录requestUniqueId字段，后续接口查询使用。一次接口请求造成的多次呼叫requestUniqueId相同；如果是加密的号码，需要URLEncode后传入', 'type' => 'string', 'required' => false, 'example' => 'requset12345'], + ], + [ + 'name' => 'UserField', + 'in' => 'query', + 'schema' => ['title' => '用户自定义字段；说明：长度不超过250个字节。1个汉字是3字节。此字段保存到通话记录userField字段，后续接口查询使用。该字段需“动态附带参数”paramNames有值时方可生效。', 'description' => '用户自定义字段；说明：长度不超过250个字节。1个汉字是3字节。此字段保存到通话记录userField字段，后续接口查询使用。该字段需“动态附带参数”paramNames有值时方可生效。', 'type' => 'string', 'required' => false, 'example' => 'UserField'], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['title' => '呼叫客户超时时间；说明：参数取值范围 0<=timeout<=60；不传入，默认30(单位:s)', 'description' => '呼叫客户超时时间；说明：参数取值范围 0<=timeout<=60；不传入，默认30(单位:s)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'Amd', 'in' => 'query', + 'schema' => ['title' => '是否开启amd；自动应答检查（传真机等），1.开启 0.不开启 默认为0', 'description' => '是否开启amd；自动应答检查（传真机等），1.开启 0.不开启 默认为0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Delay', + 'in' => 'query', + 'schema' => ['title' => '延迟时长；秒数，延迟多少秒呼叫 参数取值范围：0<=delay<=60 默认为0', 'description' => '延迟时长；秒数，延迟多少秒呼叫 参数取值范围：0<=delay<=60 默认为0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'MultiTelDelay', + 'in' => 'query', + 'schema' => ['title' => '多号码时呼叫延时；tel多个号码时，号码之间的呼叫延迟，最大120秒，默认0', 'description' => '多号码时呼叫延时；tel多个号码时，号码之间的呼叫延迟，最大120秒，默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'MultiTelPush', + 'in' => 'query', + 'schema' => ['title' => '多号码，是否每个号码呼叫都挂机推送；取值说明 0：只挂机推送一次； 1：每次呼叫都触发挂机推送；默认0', 'description' => '多号码，是否每个号码呼叫都挂机推送；取值说明 0：只挂机推送一次； 1：每次呼叫都触发挂机推送；默认0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'Clid', + 'in' => 'query', + 'schema' => ['title' => '可传入企业中继号码或设置好的客户侧外显号码', 'description' => '可传入企业中继号码或设置好的客户侧外显号码', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'ClidGroup', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显号码组；使用clidGroup需要账号支持按标识路由，优先级低于clid', 'description' => '客户侧外显号码组；使用clidGroup需要账号支持按标识路由，优先级低于clid', 'type' => 'string', 'required' => false, 'example' => 'clidGroup'], + ], + [ + 'name' => 'ClidList', + 'in' => 'query', + 'schema' => ['title' => '指定本次外呼使用的客户侧外显号码集合，系统将根据号码调度策略选择可用号码进行外呼', 'description' => '指定本次外呼使用的客户侧外显号码集合，系统将根据号码调度策略选择可用号码进行外呼', 'type' => 'string', 'required' => false, 'example' => '41008502'], + ], + [ + 'name' => 'ClidAreaCode', + 'in' => 'query', + 'schema' => ['title' => '客户侧外显指定地区号码，优先级低于clid', 'description' => '客户侧外显指定地区号码，优先级低于clid', 'type' => 'string', 'required' => false, 'example' => '010'], + ], + [ + 'name' => 'IvrId', + 'in' => 'query', + 'schema' => ['title' => '回呼接通后进入的ivrId；如果不传此参数，使用后台配置的ivr', 'description' => '回呼接通后进入的ivrId；如果不传此参数，使用后台配置的ivr', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70'], + ], + [ + 'name' => 'CrnId', + 'in' => 'query', + 'schema' => ['title' => '外显导航标识', 'description' => '外显导航标识', 'type' => 'string', 'required' => false, 'example' => '33'], + ], + [ + 'name' => 'Vid', + 'in' => 'query', + 'schema' => ['title' => '用哪种语言播放ivr提示音；1.普通话 2.粤语 4.标贝TTS 5.普通话-甜美女音 默认为1', 'description' => '用哪种语言播放ivr提示音；1.普通话 2.粤语 4.标贝TTS 5.普通话-甜美女音 默认为1', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Retry', + 'in' => 'query', + 'schema' => ['title' => '重试次数；最大5次，使用的企业需要开启webcall自动重试开关', 'description' => '重试次数；最大5次，使用的企业需要开启webcall自动重试开关', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'RetryInterval', + 'in' => 'query', + 'schema' => ['title' => '重试间隔，单位分钟，最小0分钟，最大59分钟', 'description' => '重试间隔，单位分钟，最小0分钟，最大59分钟', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'ExpirTime', + 'in' => 'query', + 'schema' => ['title' => '过期时间，精确到s，yyyy-MM-dd HH:mm:ss', 'description' => '过期时间，精确到s，yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2026-04-20 10:00:00'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FF70B74-1B3C-44C1-ACDF-8DF962988F0E'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '结果', 'description' => '结果', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + ], + ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'OK'], + ], + 'description' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'webcall接口', + 'summary' => '通过本接口，第三方平台可以给托管型呼叫中心发送呼叫请求，系统分别呼叫客户和座席，先呼叫客户再呼叫座席,并把双方接通。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"9FF70B74-1B3C-44C1-ACDF-8DF962988F0E\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Result\\": 0\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + ], + 'CreateCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '通话的任务名称。', 'type' => 'string', 'required' => false, 'example' => '语音通知'], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => '语音模板类型。取值：'."\n" + ."\n" + .'- **VMS\\_VOICE_TTS**：语音通知文本转语音模板。'."\n" + ."\n" + .'- **VMS\\_VOICE_CODE**：语音通知文件模板。'."\n" + ."\n" + .'- **VMS_TTS**：语音验证码模板。', 'type' => 'string', 'required' => false, 'example' => 'VMS_VOICE_CODE'], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => ['description' => '模板Code。取值：'."\n" + ."\n" + .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板ID**。'."\n" + ."\n" + .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音ID**。'."\n" + ."\n" + .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板ID**。', 'type' => 'string', 'required' => false, 'example' => 'TTS_2122****'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => '模板名称。取值：'."\n" + .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板名称**。'."\n" + ."\n" + .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音文件名**。'."\n" + ."\n" + .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板名称**。', 'type' => 'string', 'required' => false, 'example' => '语音通知模板'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['description' => '主叫号码类型。固定取值：**LIST**。', 'type' => 'string', 'required' => false, 'example' => 'LIST', 'default' => 'LIST'], + ], + [ + 'name' => 'Resource', + 'in' => 'query', + 'schema' => ['description' => '主叫号码，请传入服务实例ID。**目前仅支持已绑定真实号的服务实例，服务实例下未绑定真实号码无法发起通话任务**。'."\n" + ."\n" + .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)**服务实例管理**页面获取服务实例ID或绑定真实号码。', 'type' => 'string', 'required' => false, 'example' => '05516214****'], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => ['description' => '被叫号码类型。取值：'."\n" + ."\n" + .'- **LIST**：LIST格式用于无变量的文本转语音模板或语音文件。'."\n" + .'- **JSON**：JSON格式用于内含变量参数的文本转语音模板。', 'type' => 'string', 'required' => false, 'example' => 'JSON'], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'schema' => ['description' => '被叫号码或包含变量参数值的被叫数据。'."\n" + ."\n" + .'- 当**DataType**取值为**LIST**时，传入用英文半角逗号`,`分隔的被叫号码。填写格式示例`187*****123,021****1234,177*****123`。'."\n" + .'- 当**DataType**取值为**JSON**时，被叫号码及变量传参填写格式请参考示例值。示例值中`paramNames`对应文本转语音模板内的变量名，`calleelist`为被叫数据（`callee`对应被叫号码，`params`对应模板变量实际传值）。'."\n" + ."\n" + .'> 被叫号码为固话号码如`021-12345678`，应传入`02112345678`。', 'type' => 'string', 'required' => false, 'example' => '{ "paramNames":["name",,"key"], "calleeList":[ { "callee":"1310000****", "params":["张三","淘宝订单"] }, { "callee":"1320000****", "params":["李四","天猫订单"] } ] }'], + ], + [ + 'name' => 'FireTime', + 'in' => 'query', + 'schema' => ['description' => '参数暂不可用。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'StopTime', + 'in' => 'query', + 'schema' => ['description' => '参数暂不可用。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ScheduleType', + 'in' => 'query', + 'schema' => ['description' => '参数暂不可用。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '机器人任务详情信息。JSON格式。'."\n" - .'- **Id**：机器人呼叫任务的唯一任务ID。'."\n" - .'- **taskName**：任务名称。'."\n" - .'- **robotId**：指定机器人ID。'."\n" - .'- **robotName**：机器人名称。'."\n" - .'- **corpName**：公司名称。'."\n" - .'- **caller**：被叫显号。'."\n" - .'- **numberStatusIdent**：号码状态识别。**true**为识别，**false**为不识别。'."\n" - .'- **status**：任务状态。任务状态取值，请参见[QueryRobotTaskList](~~QueryRobotTaskList~~)中`status`取值。'."\n" - .'- **scheduleType**：调度类型。**SINGLE**为立即启动，**ORDER**为定时启动。'."\n" - .'- **retryType**：是否自动重拨。**1**为重拨，**0**为不重拨。'."\n" - .'- **recallStateCodes**：需要重拨的通话状态。**200010**为关机、**200011**为停机、**200002**为占线、**200012**为呼损、**200005**为无法接通。'."\n" - .'- **recallTimes**：重拨次数。'."\n" - .'- **recallInterval**：重拨间隔。单位：分钟。'."\n" - .'- **createTime**：任务创建时间。yyyy-MM-dd HH:mm:ss格式。'."\n" - .'- **fireTime**: 任务启动时间。yyyy-MM-dd HH:mm:ss格式。'."\n" - .'- **completeTime**: 任务完成时间。yyyy-MM-dd HH:mm:ss格式。'."\n" - .'- **filename**：被叫号码文件名。'."\n" - .'- **ossFilePath**：被叫号码文件地址。', - 'type' => 'string', - 'example' => '{"id":1045001,"taskName":"智能语音务","robotId":1000000075003,"robotName":"机器人","corpName":"xx公司 ","caller":"057156xxxx,0571568xxxx", "numberStatusIdent":true,"status":"INIT","scheduleType":"SINGLE", "retryType":1,"recallStateCodes":"200010,200011", "recallTimes":2,"recallInterval":5,"createTime": "2019-06-14 11:04:19","fireTime":"2019-06-14 11:05:23","completeTime": "2019-06-14 18:21:06","called": [{"fileName": "5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi", "ossFilePath": "http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx"}]}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '任务ID。使用此任务ID，通过[ExecuteCallTask](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-executecalltask?spm=a2c4g.11186623.0.0.2fb55105AJKYdF)接口执行通话任务。', 'type' => 'integer', 'format' => 'int64', 'example' => '18390**'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ED815433-724A-4357-9991-A54AD2FF09FD'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":1045001,\\\\\\"taskName\\\\\\":\\\\\\"智能语音务\\\\\\",\\\\\\"robotId\\\\\\":1000000075003,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"corpName\\\\\\":\\\\\\"xx公司 \\\\\\",\\\\\\"caller\\\\\\":\\\\\\"057156xxxx,0571568xxxx\\\\\\", \\\\\\"numberStatusIdent\\\\\\":true,\\\\\\"status\\\\\\":\\\\\\"INIT\\\\\\",\\\\\\"scheduleType\\\\\\":\\\\\\"SINGLE\\\\\\", \\\\\\"retryType\\\\\\":1,\\\\\\"recallStateCodes\\\\\\":\\\\\\"200010,200011\\\\\\", \\\\\\"recallTimes\\\\\\":2,\\\\\\"recallInterval\\\\\\":5,\\\\\\"createTime\\\\\\": \\\\\\"2019-06-14 11:04:19\\\\\\",\\\\\\"fireTime\\\\\\":\\\\\\"2019-06-14 11:05:23\\\\\\",\\\\\\"completeTime\\\\\\": \\\\\\"2019-06-14 18:21:06\\\\\\",\\\\\\"called\\\\\\": [{\\\\\\"fileName\\\\\\": \\\\\\"5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi\\\\\\", \\\\\\"ossFilePath\\\\\\": \\\\\\"http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx\\\\\\"}]}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskDetailResponse>\\n<Data>\\n <caller>0571568xxxx,0571568xxxx</caller>\\n <createTime>2019-06-14 11:04:19</createTime>\\n <status>INIT</status>\\n <retryType>1</retryType>\\n <taskName>智能语音务</taskName>\\n <robotName>机器人</robotName>\\n <id>1045001</id>\\n <numberStatusIdent>true</numberStatusIdent>\\n <scheduleType>SINGLE</scheduleType>\\n <corpName>xx公司 </corpName>\\n <recallTimes>2</recallTimes>\\n <fireTime>2019-06-14 11:05:23</fireTime>\\n <robotId>1000000075003</robotId>\\n <called>\\n <ossFilePath>http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx</ossFilePath>\\n <fileName>5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi</fileName>\\n </called>\\n <recallInterval>5</recallInterval>\\n <recallStateCodes>200010,200011</recallStateCodes>\\n <completeTime>2019-06-14 18:21:06</completeTime>\\n</Data>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n<Code>OK</Code>\\n</QueryRobotTaskDetailResponse>\\n","errorExample":""}]', - 'title' => '获取智能语音任务详情', - 'summary' => '获取指定智能语音任务详情。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"ED815433-724A-4357-9991-A54AD2FF09FD\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCallTaskResponse>\\n <Code>200</Code>\\n <Data>123456</Data>\\n <RequestId>ED815433-724A-4357-9991-A54AD2FF09FD</RequestId>\\n</CreateCallTaskResponse>","errorExample":""}]', + 'title' => '创建语音通话任务', + 'summary' => '使用服务实例给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。', + 'description' => '- **此接口仅支持专属模式且通话号码需要使用已绑定真实号的服务实例**，**服务实例下未绑定真实号码时无法发起外呼**。相关操作请参见[真实号申请](~~211339~~)及[创建服务实例](~~2261148~~)。'."\n" + ."\n" + .'- 如需使用公共模式实现批量通话，可多次调用[SingleCallByVoice](~~393517~~)或[SingleCallByTts](~~393519~~)接口，每一次调用仅支持给单个被叫号码发送语音通知或语音验证码。'."\n" + ."\n" + .'- 通话任务创建完成后，请使用[ExecuteCallTask](~~393515~~)接口执行通话任务。您也可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面执行通话任务。'."\n" + ."\n" + .'- 使用此接口创建一次通话任务，最多支持创建1000条语音通知任务。'."\n" + ."\n" + .'- 为保证用户良好的通话体验，每天12:00至14:00，21:00至次日09:00时间段内无法执行语音通话任务。如您的业务场景需要保证全天候时间段内可发起通话，可使用无时段限制的[SingleCallByVoice](~~393517~~)或[SingleCallByTts](~~393519~~)接口。'."\n" ."\n" .'### QPS限制'."\n" .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'QueryRobotTaskCallList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => '当前页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '任务名称。支持中文和英文，不超过30个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '任务测试'], ], [ - 'name' => 'PageSize', + 'name' => 'DialogId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => '指定机器人ID，即话术ID。表示选择哪个机器人话术发起呼叫。'."\n" + ."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**智能语音机器人**>**话术管理**查看话术ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000023****'], ], [ - 'name' => 'TaskId', + 'name' => 'CorpName', 'in' => 'query', - 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001****', - ], + 'schema' => ['description' => '公司名称。需和资质管理页面中的**企业名称**完全一致。', 'type' => 'string', 'required' => false, 'example' => '阿里巴巴通信技术（北京）有限公司'], ], [ - 'name' => 'DurationFrom', + 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'description' => '通话时长，左边数值。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '外呼主叫号码。'."\n" + ."\n" + .'必须是已购买的号码，多个号码使用半角逗号（,）隔开。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码**>**真实号管理**页面查看已购买的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571****5678'], ], [ - 'name' => 'DurationTo', + 'name' => 'NumberStatusIdent', 'in' => 'query', - 'schema' => [ - 'description' => '通话时长，右边数值。', - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['description' => '是否启用号码状态（早媒体）识别标识。取值：'."\n" + ."\n" + .'- **false**（默认值）：不启用。'."\n" + .'- **true**：启用。'."\n" + ."\n" + .'> 设为**true**会记录通话未接听的原因。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'], ], [ - 'name' => 'DialogCountFrom', + 'name' => 'RetryType', 'in' => 'query', - 'schema' => [ - 'description' => '对话轮次，左边数值。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '是否自动重拨。取值：'."\n" + ."\n" + .'- **1**：重拨。'."\n" + .'- **0**：不重拨。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'DialogCountTo', + 'name' => 'RecallStateCodes', 'in' => 'query', - 'schema' => [ - 'description' => '对话轮次，右边数值。', - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => '需要重拨的通话状态。多个状态使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- **200010**：关机。'."\n" + .'- **200011**：停机。'."\n" + .'- **200002**：占线。'."\n" + .'- **200012**：呼损。'."\n" + .'- **200005**：无法接通。'."\n" + .'- **200003**：无应答。'."\n", 'type' => 'string', 'required' => false, 'example' => '200010,200011'], ], [ - 'name' => 'HangupDirection', + 'name' => 'RecallTimes', 'in' => 'query', - 'schema' => [ - 'description' => '挂断方向。取值：'."\n" - ."\n" - .'- **0**：用户。'."\n" - .'- **1**：机器人。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '重拨次数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'CallResult', + 'name' => 'RecallInterval', 'in' => 'query', - 'schema' => [ - 'description' => '通话结果。取值：'."\n" - .'- **200002**：占线。'."\n" - .'- **200005**：无法接通。'."\n" - .'- **200010**：关机。'."\n" - .'- **200011**：停机。'."\n" - .'- **200012**：呼损。', - 'type' => 'string', - 'required' => false, - 'example' => '200002', - ], + 'schema' => ['description' => '重拨间隔。单位：分钟，必须大于1。'."\n" + ."\n" + .'> 最大间隔为30分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], ], [ - 'name' => 'Called', + 'name' => 'IsSelfLine', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '1300****0000', - ], + 'schema' => ['description' => '是否调用自有线路。取值：'."\n" + ."\n" + .'- **false**（默认值）：不调用。'."\n" + .'- **true**：调用。'."\n" + ."\n" + .'> 设为**true**不会对主叫号码做校验。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -4362,204 +9094,240 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '智能语音任务通话列表，JSON数组格式。'."\n" - .'- **taskId**：机器人呼叫任务的唯一任务ID。'."\n" - .'- **caller**：主叫号码。'."\n" - .'- **called**：被叫号码。'."\n" - .'- **duration**：通话时长，单位：秒。'."\n" - .'- **label**：标签。'."\n" - .'- **dialogCount**：对话轮次。'."\n" - .'- **callResult**：通话结果。'."\n" - .'- **hangupDirection**：挂断方向。**1**：用户；**0**：机器人。'."\n" - .'- **transferResult**：转接人工状态。**1**：转接成功；**0**：转接失败；**3**：未转人工。'."\n" - .'- **transferNumber**：人工座席号码。'."\n" - .'- **transferFailReson**：转接人工失败原因。'."\n" - .'- **callId**：通话的唯一回执ID。'."\n" - .'- **recallCurTimes**：重试次数。'."\n" - .'- **callStartTime**：通话开始时间。'."\n" - .'- **callEndTime**：通话结束时间。'."\n" - .'- **sureCount**：肯定次数。'."\n" - .'- **denyCount**：否定次数。'."\n" - .'- **rejectCount**：拒绝次数。'."\n" - .'- **customCount**：用户自定义次数。'."\n" - .'- **konwledgeCount**：查询知识库次数。'."\n" - .'- **defaultCount**：默认次数。'."\n" - .'- **knowledgeBusinessCount**：业务问题次数。'."\n" - .'- **knowledgeCommonCount**：通用问题次数。', - 'type' => 'string', - 'example' => '[ {"taskId":"1045001", "caller":"0571-889****", "called": "130****0000", "duration":"60", "label":"邀约，有房，无车", "dialogCount":"3", "callResult":"无法接通", "hangupDirection":"1", "transferResult":"3", "transferNumber":"0571-8833****", "transferFailReason":"用户挂断", "callId":"116950320375^10375010****", "recallCurTimes":"2", "callStartTime":"2019.06.14 15:22:23", "callEndTime":"2019.06.14 15:22:55", "sureCount":"2", "denyCount":"2", "rejectCount":"0", "customCount:"0", "knowledgeCount":"0", "defaultCount":"0", "knowledgeBusinessCount":"0", "knowledgeCommonCount":"0"} ]', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他状态码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人呼叫任务的唯一任务ID。'."\n" + ."\n" + .'任务ID可以通过[QueryRobotTaskDetail](~~393538~~)接口查询任务详情。', 'type' => 'string', 'example' => '400111****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"[ {\\\\\\"taskId\\\\\\":\\\\\\"1045001\\\\\\", \\\\\\"caller\\\\\\":\\\\\\"0571-889****\\\\\\", \\\\\\"called\\\\\\": \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\":\\\\\\"60\\\\\\", \\\\\\"label\\\\\\":\\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\":\\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\":\\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\":\\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\":\\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\":\\\\\\"0571-8833****\\\\\\", \\\\\\"transferFailReason\\\\\\":\\\\\\"用户挂断\\\\\\", \\\\\\"callId\\\\\\":\\\\\\"116950320375^10375010****\\\\\\", \\\\\\"recallCurTimes\\\\\\":\\\\\\"2\\\\\\", \\\\\\"callStartTime\\\\\\":\\\\\\"2019.06.14 15:22:23\\\\\\", \\\\\\"callEndTime\\\\\\":\\\\\\"2019.06.14 15:22:55\\\\\\", \\\\\\"sureCount\\\\\\":\\\\\\"2\\\\\\", \\\\\\"denyCount\\\\\\":\\\\\\"2\\\\\\", \\\\\\"rejectCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"customCount:\\\\\\"0\\\\\\", \\\\\\"knowledgeCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"defaultCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"knowledgeBusinessCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"knowledgeCommonCount\\\\\\":\\\\\\"0\\\\\\"} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskCallListResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>[ { “taskId” : 1045001， “caller” : “0571-889****”, “called” : “130****0000”, “duration” : “60”, “label” : “邀约，有房，无车”, “dialogCount” : “3”, “callResult” : “无法接通”, “hangupDirection” : “1”, “transferResult“ : “3”, “transferNumber” ：0571-8833****, “transferFailReason” ：“用户挂断”, “callId” ：“116950320375^10375010****”, “recallCurTimes” : 2, “callStartTime” : “2019.06.14 15:22:23”, “callEndTime” : “2019.06.14 15:22:55”, “sureCount” : 2, “denyCount” : 2, “rejectCount” : 0, “customCount” : 0, “konwledgeCount” : 0, “defaultCount” : 0, “knowledgeBusinessCount” : 0, “knowledgeCommonCount” : 0 } ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallListResponse>","errorExample":""}]', - 'title' => '查询任务内执行条目列表', - 'summary' => '查询指定任务内执行条目列表。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"400111****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","type":"json"}]', + 'title' => '发起智能语音机器人外呼任务', + 'summary' => '发起智能语音机器人外呼任务。', + 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'- 本接口用于直接使用控制台预设的机器人话术发起机器人外呼任务。在智能语音交互通话中，支持使用控制台预设的机器人话术，或在每轮通话中通过回调接口返回业务方设置的回应方式。'."\n" ."\n" .'### QPS限制'."\n" .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRobotInfoList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DegradeVideoFile' => [ + 'summary' => '从视频通话降级到语音通话。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '217975', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], ], 'parameters' => [ [ - 'name' => 'AuditStatus', + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116012354148^1028137841****'], + ], + [ + 'name' => 'MediaType', + 'in' => 'query', + 'schema' => ['description' => '媒体类型。固定取值：video。', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'AUDIO'], + ], + [ + 'name' => 'OutId', 'in' => 'query', + 'schema' => ['description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '225869*****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '接收语音通知的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '审核状态，取值：'."\n" - .'- **CONFIGURABLE**：可配置。'."\n" - .'- **AUDITING**：审核中 。'."\n" - .'- **AUDITPASS**：审核通过。'."\n" - .'- **AUDITFAIL**：审核失败。', - 'type' => 'string', - 'required' => false, - 'example' => 'AUDITING', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误提示信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回的数据内容。', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '视频降级', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DegradeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:DegradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'DeleteRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '机器人的基本信息，JSON格式。参数如下：'."\n" - .'- **id**：机器人id。'."\n" - .'- **robotName**：机器人名称。'."\n" - .'- **robotType**：机器人类型。'."\n" - .'- **auditStatus**：审核状态。'."\n" - .'- **gmtCreate**：创建时间。'."\n" - .'- **gmtModified**：修改时间。'."\n" - .'- **partnerId**：合作伙伴ID。'."\n" - .'- **asrId**：ASR模型ID。'."\n" - .'- **asrType**：ASR类型，包括**公有**和**私有**。'."\n" - .'- **remark**：备注说明。', - 'type' => 'string', - 'example' => '{["id":1000010920004, "gmtModified":"Thu Mar 21 15:38:55 CST 2019", "auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 12:00:51 CST 2019","remark":"测试勿删，测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5--ssml标记2-RVR-副本"},{"id":1000010920003,"gmtModified":"Thu Mar 21 11:51:10 CST 2019","auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 11:44:57 CST 2019","remark":"测试勿删，内部测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5-ssml标记2-RVR"]}', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F59AF338-655D-48E8-9471-5EB07692B1CC', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', 'type' => 'string', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{[\\\\\\"id\\\\\\":1000010920004, \\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 15:38:55 CST 2019\\\\\\", \\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 12:00:51 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5--ssml标记2-RVR-副本\\\\\\"},{\\\\\\"id\\\\\\":1000010920003,\\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 11:51:10 CST 2019\\\\\\",\\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 11:44:57 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，内部测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5-ssml标记2-RVR\\\\\\"]}\\",\\n \\"RequestId\\": \\"F59AF338-655D-48E8-9471-5EB07692B1CC\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<QueryRobotInfoListResponse>\\r\\n\\t<Data>[{\\"id\\":1000010920004,\\"gmtModified\\":\\"Thu Mar 21 15:38:55 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 12:00:51 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景5-ssml标记2-RVR-副本\\"},{\\"id\\":1000010920003,\\"gmtModified\\":\\"Thu Mar 21 11:51:10 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 11:44:57 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景-ssml标记2-RVR\\"}}]</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>E8EF9B41-C4DC-44D5-A25B-DA9AC7791998</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryRobotInfoListResponse>","errorExample":""}]', - 'title' => '查询智能语音机器人列表', - 'summary' => '查看智能语音机器人列表，获取机器人详细信息。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<TaskId>4001112222</TaskId>\\n</DeleteRobotTaskResponse>","errorExample":""}]', + 'title' => '删除智能语音任务', + 'summary' => '删除智能语音任务。', + 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'- 此接口仅支持删除未开始状态、已完成状态以及被终止的任务。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryRobotTaskCallDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dyvms:DeleteRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ExecuteCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '77094', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], ], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045001', - ], + 'schema' => ['description' => '任务ID。通过[CreateCallTask](~~CreateCallTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2256****'], ], [ - 'name' => 'Callee', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '被叫号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '130****0000', - ], + 'schema' => ['description' => '任务启动状态。取值：'."\n" + ."\n" + .'- **RUNNING**：立即启动。'."\n" + .'- **STOP**：停止任务。'."\n" + .'- **CANCEL**：取消任务。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RUNNING'], ], [ - 'name' => 'QueryDate', + 'name' => 'FireTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询时间，请使用时间戳格式。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1603239801000', - ], + 'schema' => ['description' => '定时启动时间。格式为：yyyy-MM-dd HH:mm:ss。'."\n" + ."\n\n" + .'> 如果此处为空，则不用填写该字段。'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-03-09 00:00:00'], ], ], 'responses' => [ @@ -4568,78 +9336,114 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '智能语音任务通话详情，JSON格式。'."\n" - .'- **taskId**：机器人呼叫任务的唯一任务ID。'."\n" - .'- **caller**：主叫号码。'."\n" - .'- **called**：被叫号码。'."\n" - .'- **duration**：通话时长。单位：秒。'."\n" - .'- **label**：标签。'."\n" - .'- **dialogCount**：对话轮次。'."\n" - .'- **callResult**：通话结果。'."\n" - .'- **hangupDirection**：挂断方向。**0**：机器人。**1**：用户。'."\n" - .'- **transferResult**：转接人工状态。**1**：转接成功，**0**：转接失败，**3**：未转人工。'."\n" - .'- **transferNumber**：人工座席号码。'."\n" - .'- **transferFailReson**：转接人工失败原因。'."\n" - .'- **callId**：通话的唯一回执ID。组成形成：`taskId+^+bizId`。'."\n" - .'- **recallCurTimes**：重试次数。'."\n" - .'- **callStartTime**：通话开始时间。'."\n" - .'- **callEndTime**：通话结束时间。'."\n" - .'- **sureCount**：肯定次数。'."\n" - .'- **denyCount**：否定次数。'."\n" - .'- **rejectCount**：拒绝次数。'."\n" - .'- **customCount**：自定义次数。'."\n" - .'- **knowledgeCount**：知识库次数。'."\n" - .'- **defaultCount**：默认次数。'."\n" - .'- **knowledgeBusinessCount**：业务问题次数。'."\n" - .'- **knowledgeCommonCount**：通用问题次数。'."\n" - .'- **recordStatus**：录音文件状态。**1**：有录音文件；**2**：没有录音文件。'."\n" - .'- **recordFile**：录音文件下载地址。'."\n" - .'- **dialogDetail**：对话明细，Json数组。**role**：发言对象；**content**：发言内容；**speakTime**：发言时间。'."\n", - 'type' => 'string', - 'example' => '{ "taskId" : 1045001, "caller" : "0571-8899****", "called" : "130****0000", "duration" : "60", "label" : "邀约，有房，无车", "dialogCount": "3", "callResult" : "无法接通", "hangupDirection" : "1", "transferResult" : "3", "transferNumber" ：0571-8833****, "transferFailReason" ："用户挂断", "callId" ："116950320375^10375010****", "recallCurTimes" : 2, "callStartTime" : "2019.06.14 15:22:23", "callEndTime" : "2019.06.14 15:22:55", "sureCount" : 2, "denyCount" : 2, "rejectCount" : 0, "customCount" : 0, "knowledgeCount" : 0, "defaultCount" : 0, "knowledgeBusinessCount" : 0, "knowledgeCommonCount" : 0, "recordStatus":1, "recordFile": "http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******", "dialogDetail": [{"role": "robot","speakTime": "2019-06-19 20:44:17","content":"开场白"}] }', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], + 'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功'."\n" + .'- **false**：失败', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{ \\\\\\"taskId\\\\\\" : 1045001, \\\\\\"caller\\\\\\" : \\\\\\"0571-8899****\\\\\\", \\\\\\"called\\\\\\" : \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\" : \\\\\\"60\\\\\\", \\\\\\"label\\\\\\" : \\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\": \\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\" : \\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\" : \\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\" : \\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\" ：0571-8833****, \\\\\\"transferFailReason\\\\\\" ：\\\\\\"用户挂断\\\\\\", \\\\\\"callId\\\\\\" ：\\\\\\"116950320375^10375010****\\\\\\", \\\\\\"recallCurTimes\\\\\\" : 2, \\\\\\"callStartTime\\\\\\" : \\\\\\"2019.06.14 15:22:23\\\\\\", \\\\\\"callEndTime\\\\\\" : \\\\\\"2019.06.14 15:22:55\\\\\\", \\\\\\"sureCount\\\\\\" : 2, \\\\\\"denyCount\\\\\\" : 2, \\\\\\"rejectCount\\\\\\" : 0, \\\\\\"customCount\\\\\\" : 0, \\\\\\"knowledgeCount\\\\\\" : 0, \\\\\\"defaultCount\\\\\\" : 0, \\\\\\"knowledgeBusinessCount\\\\\\" : 0, \\\\\\"knowledgeCommonCount\\\\\\" : 0, \\\\\\"recordStatus\\\\\\":1, \\\\\\"recordFile\\\\\\": \\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\\\\\", \\\\\\"dialogDetail\\\\\\": [{\\\\\\"role\\\\\\": \\\\\\"robot\\\\\\",\\\\\\"speakTime\\\\\\": \\\\\\"2019-06-19 20:44:17\\\\\\",\\\\\\"content\\\\\\":\\\\\\"开场白\\\\\\"}] }\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskCallDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>{ \\"taskId\\" : 1045001, \\"caller\\" : \\"0571-8899****\\", \\"called\\" : \\"130****0000\\", \\"duration\\" : \\"60\\", \\"label\\" : \\"邀约，有房，无车\\", \\"dialogCount\\": \\"3\\", \\"callResult\\" : \\"无法接通\\", \\"hangupDirection\\" : \\"1\\", \\"transferResult\\" : \\"3\\", \\"transferNumber\\" ：0571-8833****, \\"transferFailReason\\" ：\\"用户挂断\\", \\"callId\\" ：\\"116950320375^10375010****\\", \\"recallCurTimes\\" : 2, \\"callStartTime\\" : \\"2019.06.14 15:22:23\\", \\"callEndTime\\" : \\"2019.06.14 15:22:55\\", \\"sureCount\\" : 2, \\"denyCount\\" : 2, \\"rejectCount\\" : 0, \\"customCount\\" : 0, \\"konwledgeCount\\" : 0, \\"defaultCount\\" : 0, \\"knowledgeBusinessCount\\" : 0, \\"knowledgeCommonCount\\" : 0, \\"recordStatus\\":1, \\"recordFile\\": \\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\", \\"dialogDetail\\": [{\\"role\\": \\"robot\\",\\"speakTime\\": \\"2019-06-19 20:44:17\\",\\"content\\":\\"开场白\\"}] }</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallDetailResponse>","errorExample":""}]', - 'title' => '查询智能机器人任务执行详情', - 'summary' => '获取单个执行条目即单个被叫号码的任务明细。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" - ."\n" - .'### QPS限制'."\n" + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD\\"\\n}","errorExample":""},{"type":"xml","example":"<ExecuteCallTaskResponse>\\n <Code>200</Code>\\n <Data>true</Data>\\n <RequestId>53D0F0Fe-cbbB-De28-6FCd-DdbBcefA46dD</RequestId>\\n</ExecuteCallTaskResponse>","errorExample":""}]', + 'title' => '执行语音通话任务', + 'summary' => '执行通话任务。', + 'description' => '### QPS限制'."\n" .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:ExecuteCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'UploadRobotTaskCalledFile' => [ - 'methods' => [ - 'post', - 'get', + 'GetCallMediaType' => [ + 'summary' => '在通话时获取通话类型。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'schemes' => [ - 'http', - 'https', + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '通话中的手机号码。', 'type' => 'string', 'required' => true, 'example' => '1580000****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => 'MediaType：媒体类型。'."\n" + ."\n" + .'- audio'."\n" + .'- video'."\n" + .'- Null（切换中不确定）', 'type' => 'object', 'example' => 'video'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '请求是否成功。'."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取通话类型', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallMediaType'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'GetHotlineQualificationByOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4647,59 +9451,323 @@ ], 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '52683', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'OrderId', 'in' => 'query', + 'schema' => ['description' => '工单号。'."\n" + ."\n" + .'您可以在[语音服务控制台400资质页面](https://dyvms.console.aliyun.com/qualification/400)查看工单号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '153345012****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '机器人呼叫任务的唯一任务ID。可通过[CreateRobotTask](~~CreateRobotTask~~)接口获取。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1045****', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他状态码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '资质状态。取值：'."\n" + ."\n" + .'- **NORMAL**：正常状态。'."\n" + .'- **OTHER**：不正常状态。', 'type' => 'string', 'example' => 'NORMAL'], + 'QualificationId' => ['description' => '400号码的资质ID。', 'type' => 'string', 'example' => '10000008748****'], + 'OrderId' => ['description' => '申请工单号。', 'type' => 'string', 'example' => '15334****'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An internal server error occurred.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"QualificationId\\": \\"10000008748****\\",\\n \\"OrderId\\": \\"15334****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineQualificationByOrderResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n <Data>\\n <Status>NORMA</Status>\\n <QualificationId>1478*****</QualificationId>\\n <OrderId>22456****</OrderId>\\n </Data>\\n</GetHotlineQualificationByOrderResponse>","errorExample":""}]', + 'title' => '获取400号码资质ID', + 'summary' => '通过资质申请工单号获取400号码的资质ID。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineQualificationByOrder'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetHotlineQualificationByOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetTemporaryFileUrl' => [ + 'summary' => '获取视频或语音文件临时URL，方便您立即查看视频或语音文件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CalledNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'VideoId', 'in' => 'query', + 'schema' => ['description' => '音频或视频ID。'."\n" + ."\n" + .'您可以在语音服务控制台[语音文件管理](https://dyvms.console.aliyun.com/files/list/voiceFiles)页面或[视频文件管理](https://dyvms.console.aliyun.com/videoFiles/list/slot)页面，查看语音ID或视频ID。', 'type' => 'string', 'required' => true, 'example' => '45a04670582571eebf9e4531948c****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '被叫号码。多个号码之间使用半角逗号（,）分隔。'."\n" - ."\n" - .'> 在创建智能语音机器人任务后，需要分批上传被叫号码，每个任务最多上传30万个号码，可分多次上传完成。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1370****000,1370****111', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A****'], + 'Data' => ['description' => '- private String videoFileUrl：播放文件URL'."\n" + .'- private String videoFile：语音或视频文件'."\n" + .'- private Long fileExpireTime：文件过期时间，单位毫秒', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A****\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取文件临时URL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemporaryFileUrl'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'GetToken' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TtsParam', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '52685', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'TokenType', 'in' => 'query', + 'schema' => ['description' => 'Token类型。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dyvms', 'minLength' => 0], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'TTS模板的变量值。格式为JSON。TtsParam和TtsParamHead变量名称一一对应。'."\n" - ."\n" - .'- 如果全部号码携带的参数相同，可将number字段里的值写为**all**，变量值仅需上传一份即可。'."\n" - .'- 如果部分号码携带的参数相同，可将number字段里的值写为**all**，其他号码正常输入number值和对应的变量值，系统会优先取号码自带值。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '[{"number":"1370****000","params":["小王","小李","小周"]}]', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Token' => ['description' => 'Token。', 'type' => 'string', 'example' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD'], + 'Success' => ['description' => '接口调用是否成功。', 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Token\\": \\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetTokenResponse>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD</RequestId>\\n<Token>eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZiI6MTYyMzM5NDQ2Ny****</Token>\\n<Code>OK</Code>\\n<Success>true</Success>\\n</GetTokenResponse>","errorExample":""}]', + 'title' => '获取认证的Token', + 'summary' => '获取认证的Token。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：5次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'IvrCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TtsParamHead', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52686', + 'abilityTreeNodes' => ['FEATUREdyvms4MLIJE'], + ], + 'parameters' => [ + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => '主叫号码。'."\n" + ."\n" + .'必须是已购买的号码，单次请求仅支持一个主叫号码。一般号码都有并发数，超过并发数会请求失败。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码>真实号管理**页面查看已购买的号码。', 'type' => 'string', 'required' => true, 'example' => '0571****5678'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。'."\n" + ."\n" + .'仅支持中国内地号码，单次请求仅支持一个号码。', 'type' => 'string', 'required' => true, 'example' => '1590****000'], + ], + [ + 'name' => 'StartCode', + 'in' => 'query', + 'schema' => ['description' => '呼叫开始时播放的提示音。'."\n" + ."\n" + .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" + .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音消息**>**语音通知**>**文本转语音模板**页面查看**模板ID**。', 'type' => 'string', 'required' => true, 'example' => 'TTS_1234****'], + ], + [ + 'name' => 'StartTtsParams', 'in' => 'query', + 'schema' => ['description' => '文本转语音模板内的变量参数，格式为JSON。'."\n" + ."\n" + .'> 当StartCode为文本转语音模板（TTS）且模板中带变量的情况下，此参数必填。', 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"}'], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => '重复播放次数。取值范围为**1~3**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'ByeCode', + 'in' => 'query', + 'schema' => ['description' => '播放结束时播放的结束提示音。支持以下两种方式：'."\n" + ."\n" + .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" + .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**国内语音单呼**>**语音通知**>**文本转语音模板**页面查看**模板ID**。'."\n" + ."\n" + .'> 参数ByeCode的类型需要与参数StartCode一致，即必须同时为语音文件或同时为文本转语音（TTS）模板。', 'type' => 'string', 'required' => false, 'example' => 'TTS_1234****'], + ], + [ + 'name' => 'ByeTtsParams', + 'in' => 'query', + 'schema' => ['description' => '文本转语音模板中的变量参数。格式为JSON。'."\n" + ."\n" + .'> 当ByeCode为文本转语音（TTS）模板且模板中带变量的情况下，此参数必填。', 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"} '], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => ['description' => '等待用户按键超时时间。单位：毫秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => 'PR0210428****'], + ], + [ + 'name' => 'MenuKeyMap', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'description' => '带变量的呼叫任务。格式为JSON。变量名称列表，和TtsParam配合使用。', - 'type' => 'string', + 'description' => '按键信息。', + 'type' => 'array', + 'items' => [ + 'description' => '按键信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '被叫方可按的电话按键。', 'type' => 'string', 'required' => false, 'example' => '1'], + 'TtsParams' => ['description' => '文本转语音模板内的变量参数，格式为JSON。'."\n" + ."\n" + .'> - 当**MenuKeyMap.N.Code**是文本转语音模板（TTS）时，对应的模板变量替换关系。'."\n" + .'> - 当**MenuKeyMap.N.Code**为文本转语音模板（TTS）且模板中带变量的情况下，此参数为必填。', 'type' => 'string', 'required' => false, 'example' => '{"name":"xxx","code":"123"}'], + 'Code' => ['description' => '**MenuKeyMap.N.Key**中指定按键对应的提示音。支持以下两种方式：'."\n" + ."\n" + .'- 语音文件：语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" + .'- 文本转语音模板：模板ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音消息**>**语音通知**>**文本转语音模板**页面查看**模板ID**。', 'type' => 'string', 'required' => false, 'example' => 'TTS_1235****'], + ], + 'required' => false, + ], 'required' => false, 'docRequired' => true, - 'example' => '["name1","name2","name3"]', + 'maxItems' => 15, ], ], ], @@ -4709,84 +9777,123 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '机器人呼叫任务的唯一任务ID。'."\n" - ."\n" - .'可通过此ID调用[QueryRobotTaskDetail](~~QueryRobotTaskDetail~~)接口查询任务详情。', - 'type' => 'string', - 'example' => '10450****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'CallId' => ['description' => '此次通话的唯一回执ID。'."\n" + ."\n" + .'CallId可以通过[QueryCallDetailByCallId](~~393529~~)接口查询指定通话的呼叫详情。', 'type' => 'string', 'example' => '116012354148^10281378****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10450****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<UploadRobotTaskCalledFileResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>10450****</Data>\\n</UploadRobotTaskCalledFileResponse>","errorExample":""}]', - 'title' => '上传智能语音的被叫号码', - 'summary' => '上传智能语音任务的被叫号码。', - 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => '向指定号码发起交互式语音通话', + 'summary' => '向指定号码发起交互式语音通话。', + 'description' => '- 提交企业资质，并审核通过。具体操作，请参见[提交企业资质](~~149795~~)。'."\n" + .'- 购买语音号码。具体操作，请参见[购买号码](~~149794~~)。'."\n" ."\n" - .'### QPS限制'."\n" + .'- 用户接听电话后会听到一段语音，提示用户按键选择。如果开启了[消息回执](~~112503~~)，语音服务会将客户按键信息返回给调用的业务系统。该接口可用于收集客户的订单确认、问卷调查、满意度调查等信息。'."\n" + ."\n" + .'## QPS限制'."\n" .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetHotlineQualificationByOrder' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IvrCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:IvrCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52683', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'OrderId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '工单号。'."\n" - ."\n" - .'您可以在[语音服务控制台400资质页面](https://dyvms.console.aliyun.com/qualification/400)查看工单号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '153345012****', - ], + 'schema' => ['description' => '当前页码。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页显示的任务个数。默认取值为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '10'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['description' => '模板名称。'."\n" + .'- 如果是语音通知文本转语音模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/textToVoice)**文本转语音模板**页面获取**模板名称**。'."\n" + ."\n" + .'- 如果是语音通知文件模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/list/voiceFiles)**语音通知文件**页面获取**语音文件名**。'."\n" + ."\n" + .'- 如果是语音验证码模板，可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/code/list)**语音验证码**页面获取**模板名称**。', 'type' => 'string', 'required' => false, 'example' => '身份验证'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态。取值：'."\n" + ."\n" + .'- **INIT**：新建任务，任务未启动。'."\n" + .'- **RELEASE**：任务解析中。'."\n" + .'- **RUNNING**：任务运行中。'."\n" + .'- **STOP**：任务暂停。'."\n" + .'- **SYSTEM_STOP**：系统暂停。'."\n" + .'- **CANCEL**：任务取消。'."\n" + .'- **SYSTEM_CANCEL**：系统取消。'."\n" + .'- **DONE**：任务已完成。'."\n" + ."\n" + .'> 您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态。', 'type' => 'string', 'required' => false, 'example' => 'INIT'], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '任务名称。'."\n" + ."\n" + .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务名称。', 'type' => 'string', 'required' => false, 'example' => '验证码'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '任务ID。'."\n" + ."\n" + .'- 通过[CreateCallTask接口](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.51c25dac5r5vgj)获取任务ID。'."\n" + ."\n" + .'- 在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务ID。', 'type' => 'string', 'required' => false, 'example' => '18908**'], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => '任务模板类型。取值：'."\n" + ."\n" + .'- **VMS_VOICE_TTS**：语音通知文本转语音模板。'."\n" + .'- **VMS_VOICE_CODE**：语音通知文件模板。'."\n" + .'- **VMS_TTS**：语音验证码模板。', 'type' => 'string', 'required' => false, 'example' => 'VMS_TTS'], ], ], 'responses' => [ @@ -4795,45 +9902,52 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他状态码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回200代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => '200'], + 'PageSize' => ['description' => '每页显示的任务个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5B0F201F-DCDA-45C2-AA92-1AE177F94991'], + 'Total' => ['description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Data' => [ - 'description' => '返回数据。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '资质状态。取值：'."\n" + 'description' => '任务信息。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '任务状态。取值：'."\n" ."\n" - .'- **NORMAL**：正常状态。'."\n" - .'- **OTHER**：不正常状态。', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'QualificationId' => [ - 'description' => '400号码的资质ID。', - 'type' => 'string', - 'example' => '10000008748****', - ], - 'OrderId' => [ - 'description' => '申请工单号。', - 'type' => 'string', - 'example' => '15334****', + .'- **INIT**：新建任务，任务未启动。'."\n" + .'- **RELEASE**：任务解析中。'."\n" + .'- **RUNNING**：任务运行中。'."\n" + .'- **STOP**：任务暂停。'."\n" + .'- **SYSTEM_STOP**：系统暂停。'."\n" + .'- **CANCEL**：任务取消。'."\n" + .'- **SYSTEM_CANCEL**：系统取消。'."\n" + .'- **DONE**：任务已完成。'."\n" + ."\n" + .'> 您可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态。', 'type' => 'string', 'example' => 'INIT'."\n"], + 'Data' => ['description' => '返回的任务状态数据。', 'type' => 'string', 'example' => '1'], + 'DataType' => ['description' => '被叫号码类型。'."\n" + ."\n" + .'在[创建通话任务](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.c24e3a52pFfNZV)时已选择被叫号码类型。', 'type' => 'string', 'example' => 'LIST'], + 'TaskName' => ['description' => '任务名称。', 'type' => 'string', 'example' => '验证码'], + 'CompletedCount' => ['description' => '已完成任务的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'TotalCount' => ['description' => '被叫号码总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], + 'TemplateName' => ['description' => '模板名称。', 'type' => 'string', 'example' => '身份验证'], + 'StopTime' => ['description' => '任务暂停时间。', 'type' => 'string', 'example' => '1614332378000'], + 'BizType' => ['description' => '任务模板类型。取值：'."\n" + ."\n" + .'- **VMS_VOICE_TTS**：语音通知文本转语音模版。'."\n" + .'- **VMS_VOICE_CODE**：语音通知文件模版。'."\n" + .'- **VMS_TTS**：语音验证码模版。', 'type' => 'string', 'example' => 'VMS_TTS'], + 'Resource' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0571000****'], + 'TemplateCode' => ['description' => '语音模板ID。', 'type' => 'string', 'example' => 'TTS_28292****'], + 'FireTime' => ['description' => '定时启动任务。Unix时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1614330978000'], + 'CompleteTime' => ['description' => '任务完成时间。Unix时间戳格式，单位：毫秒。', 'type' => 'string', 'example' => '1614330986000'], + 'CompletedRate' => ['description' => '任务执行进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '26%'], + 'Id' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1605***'], ], ], ], @@ -4843,36 +9957,157 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An internal server error occurred.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"5B0F201F-DCDA-45C2-AA92-1AE177F94991\\",\\n \\"Total\\": 1,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"INIT\\\\n\\",\\n \\"Data\\": \\"1\\",\\n \\"DataType\\": \\"LIST\\",\\n \\"TaskName\\": \\"验证码\\",\\n \\"CompletedCount\\": 2,\\n \\"TotalCount\\": 6,\\n \\"TemplateName\\": \\"身份验证\\",\\n \\"StopTime\\": \\"1614332378000\\",\\n \\"BizType\\": \\"VMS_TTS\\",\\n \\"Resource\\": \\"0571000****\\",\\n \\"TemplateCode\\": \\"TTS_28292****\\",\\n \\"FireTime\\": \\"1614330978000\\",\\n \\"CompleteTime\\": \\"1614330986000\\",\\n \\"CompletedRate\\": 0,\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCallTaskResponse>\\n <RequestId>5B0F201F-DCDA-45C2-AA92-1AE177F94991</RequestId>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>20</Total>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614330978000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>0fec3add-ef76-4c24-9728-666ababae9d6--alicomTask.xlsx</Data>\\n <CompletedCount>1</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>1</TotalCount>\\n <TaskName>测试任务</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>LIST</DataType>\\n <Id>1951001</Id>\\n <CompleteTime>1614330986000</CompleteTime>\\n </Data>\\n <Data>\\n <Status>DONE</Status>\\n <FireTime>1614159414000</FireTime>\\n <Resource>05516214****</Resource>\\n <BizType>VMS_VOICE_TTS</BizType>\\n <Data>dyvms_51bae600-1e0c-4f65-9fb5-5811fd2226b7.xlsx</Data>\\n <CompletedCount>2</CompletedCount>\\n <TemplateCode>TTS_21194****</TemplateCode>\\n <TotalCount>2</TotalCount>\\n <TaskName>任务中心</TaskName>\\n <CompletedRate>10000</CompletedRate>\\n <TemplateName>特服号码测试模板</TemplateName>\\n <DataType>FILE</DataType>\\n <Id>195002</Id>\\n <CompleteTime>1614159424000</CompleteTime>\\n </Data>\\n <Code>200</Code>\\n</ListCallTaskResponse>","errorExample":""}]', + 'title' => '获取通话任务状态列表', + 'summary' => '创建语音通话任务后，可以查看通话任务状态，包括：任务ID、任务当前状态、任务所选的模板信息等。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：100次/秒。'."\n" + .'### 接口说明'."\n" + .'您也可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，查看任务状态，并根据需要对任务进行**启动**、**定时启动**、**编辑**、**取消任务**等操作。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + ], + 'ListCallTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NORMAL\\",\\n \\"QualificationId\\": \\"10000008748****\\",\\n \\"OrderId\\": \\"15334****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineQualificationByOrderResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n <Data>\\n <Status>NORMA</Status>\\n <QualificationId>1478*****</QualificationId>\\n <OrderId>22456****</OrderId>\\n </Data>\\n</GetHotlineQualificationByOrderResponse>","errorExample":""}]', - 'title' => '获取400号码资质ID', - 'summary' => '通过资质申请工单号获取400号码的资质ID。', + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '任务ID。'."\n" + ."\n" + .'- 通过[CreateCallTask接口](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.4b0a7be3m1G1Kx)获取任务ID。'."\n" + ."\n" + .'- 在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)任务中心页面获取任务ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '18908**'], + ], + [ + 'name' => 'CalledNum', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '1390000****'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态。取值：'."\n" + ."\n" + .'- **SUCCESS**：外呼成功。'."\n" + .'- **FAIL**：外呼失败。'."\n" + .'- **INIT**：未开始外呼。', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页显示的任务个数。默认值为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D692AC3D-CBA8-417F-BEB9-5B73718922D4'], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页显示的任务个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Total' => ['description' => '被叫号码总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Data' => [ + 'description' => '任务详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '任务状态。取值：'."\n" + ."\n" + .'- **SUCCESS**：外呼成功。'."\n" + .'- **FAIL**：外呼失败。'."\n" + .'- **INIT**：未外呼。', 'type' => 'string', 'example' => 'SUCCESS'], + 'Duration' => ['description' => '通话时长。单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'CalledNum' => ['description' => '被叫号码。', 'type' => 'string', 'example' => '1390000****'], + 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'example' => '0571000****'], + 'Id' => ['description' => '操作ID。此参数暂时不可用。', 'type' => 'integer', 'format' => 'int64', 'example' => '43085***'], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D692AC3D-CBA8-417F-BEB9-5B73718922D4\\",\\n \\"Code\\": \\"OK\\",\\n \\"TotalPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Duration\\": 10,\\n \\"CalledNum\\": \\"1390000****\\",\\n \\"Caller\\": \\"0571000****\\",\\n \\"Id\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListCallTaskDetailResponse>\\n <RequestId>7C943A5D-E12A-4184-A5F8-CF57B92815E3</RequestId>\\n <TotalPage>500</TotalPage>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <Total>1000</Total>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1300001****</CalledNum>\\n </Data>\\n <Data>\\n <Status>FAIL</Status>\\n <Caller>05516214****</Caller>\\n <Duration>0</Duration>\\n <CalledNum>1310000****</CalledNum>\\n </Data>\\n <Code>OK</Code>\\n</ListCallTaskDetailResponse>","errorExample":""}]', + 'title' => '获取通话任务详情列表', + 'summary' => '执行完通话任务后根据任务ID，查看指定任务详情。', 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。', + .'单用户调用频率：100次/秒。'."\n" + .'### 接口说明'."\n" + .'您还可以在[语音服务控制台](https://dyvms.console.aliyun.com/call/task/list)**任务中心**页面，单击操作栏**任务详情**，查看通话任务详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTaskDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'ListHotlineTransferRegisterFile' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4882,60 +10117,28 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '52690', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], ], 'parameters' => [ [ 'name' => 'QualificationId', 'in' => 'query', - 'schema' => [ - 'description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000****', - ], + 'schema' => ['description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000****'], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '页码。默认取值为**1**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => '页码。默认取值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '0', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '页数。取值范围：**1~10**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1000', - 'exclusiveMaximum' => false, - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => '页数。取值范围：**1~10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'exclusiveMaximum' => false, 'minimum' => '1', 'example' => '10'], ], [ 'name' => 'HotlineNumber', 'in' => 'query', - 'schema' => [ - 'description' => '400号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => '400号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****'], ], ], 'responses' => [ @@ -4944,99 +10147,36 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Values' => [ 'description' => '备案文件。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'MngOpMail' => [ - 'description' => '经办人邮箱。', - 'type' => 'string', - 'example' => 'username@example.com', - ], - 'MngOpName' => [ - 'description' => '经办人姓名。', - 'type' => 'string', - 'example' => 'A***', - ], - 'CorpName' => [ - 'description' => '企业名称。', - 'type' => 'string', - 'example' => 'A**', - ], - 'Agree' => [ - 'description' => '确认承诺书真实性。', - 'type' => 'string', - 'example' => 'true', - ], - 'MngOpMobile' => [ - 'description' => '经办人手机号。', - 'type' => 'string', - 'example' => '150****0000', - ], - 'MngOpIdentityCard' => [ - 'description' => '经办人身份证号。', - 'type' => 'string', - 'example' => '5****************9', - ], - 'HotlineNumber' => [ - 'description' => '400号码。', - 'type' => 'string', - 'example' => '400903****', - ], - 'QualificationId' => [ - 'description' => '资质ID。', - 'type' => 'string', - 'example' => '10000004933****', - ], - 'ResUniqueCode' => [ - 'description' => '资源唯一编码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'MngOpMail' => ['description' => '经办人邮箱。', 'type' => 'string', 'example' => 'username@example.com'], + 'MngOpName' => ['description' => '经办人姓名。', 'type' => 'string', 'example' => 'A***'], + 'CorpName' => ['description' => '企业名称。', 'type' => 'string', 'example' => 'A**'], + 'Agree' => ['description' => '确认承诺书真实性。', 'type' => 'string', 'example' => 'true'], + 'MngOpMobile' => ['description' => '经办人手机号。', 'type' => 'string', 'example' => '150****0000'], + 'MngOpIdentityCard' => ['description' => '经办人身份证号。', 'type' => 'string', 'example' => '5****************9'], + 'HotlineNumber' => ['description' => '400号码。', 'type' => 'string', 'example' => '400903****'], + 'QualificationId' => ['description' => '资质ID。', 'type' => 'string', 'example' => '10000004933****'], + 'ResUniqueCode' => ['description' => '资源唯一编码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'description' => '', ], ], ], @@ -5047,10 +10187,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 1,\\n \\"Values\\": [\\n {\\n \\"MngOpMail\\": \\"username@example.com\\",\\n \\"MngOpName\\": \\"A***\\",\\n \\"CorpName\\": \\"A**\\",\\n \\"Agree\\": \\"true\\",\\n \\"MngOpMobile\\": \\"150****0000\\",\\n \\"MngOpIdentityCard\\": \\"5****************9\\",\\n \\"HotlineNumber\\": \\"400903****\\",\\n \\"QualificationId\\": \\"10000004933****\\",\\n \\"ResUniqueCode\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', @@ -5061,314 +10198,448 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SubmitHotlineTransferRegister' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineTransferRegisterFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:ListHotlineTransferRegisterFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListServiceInstanceForPage' => [ + 'summary' => '分页查询服务实例列表', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'TransferPhoneNumberInfos', + 'name' => 'Code', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '号码备案信息。', - 'type' => 'array', - 'items' => [ - 'description' => '号码备案信息。', - 'type' => 'object', - 'properties' => [ - 'PhoneNumber' => [ - 'description' => '备案号码。', - 'type' => 'string', - 'required' => true, - 'example' => '1580000****', - ], - 'PhoneNumberOwnerName' => [ - 'description' => '机主真实姓名或公司名。', - 'type' => 'string', - 'required' => true, - 'example' => 'A***', - ], - 'IdentityCard' => [ - 'description' => '机主身份证号。', - 'type' => 'string', - 'required' => true, - 'example' => '500***', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 10, - ], + 'schema' => ['title' => '服务实例号', 'description' => '服务实例号', 'type' => 'string', 'required' => false, 'example' => '0571****1234'], ], [ - 'name' => 'QualificationId', + 'name' => 'SceneId', 'in' => 'query', - 'schema' => [ - 'description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10000004933****', - ], + 'schema' => ['title' => '场景ID', 'description' => '场景ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56'], ], [ - 'name' => 'OperatorName', + 'name' => 'UsageId', 'in' => 'query', - 'schema' => [ - 'description' => '经办人姓名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'A***', - ], + 'schema' => ['title' => '用途ID', 'description' => '用途ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89'], ], [ - 'name' => 'OperatorMail', + 'name' => 'RelationNumber', 'in' => 'query', - 'schema' => [ - 'description' => '经办人邮箱。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'username@example.com', - ], + 'schema' => ['title' => '关联实体号码', 'description' => '关联实体号码', 'type' => 'string', 'required' => false, 'example' => '131****1111'], ], [ - 'name' => 'OperatorMailVerifyCode', + 'name' => 'Pager', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '经办人邮箱验证码。', - 'type' => 'string', + 'title' => '', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['title' => '每页数量，默认10，最大100', 'description' => '每页数量，默认10，最大100', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'PageIndex' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], 'required' => false, - 'docRequired' => true, - 'example' => '1234', + 'example' => '', ], ], - [ - 'name' => 'OperatorMobile', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '经办人手机号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '158****7230', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['title' => '请求唯一id', 'description' => '请求唯一id', 'type' => 'string', 'example' => ' ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE'], + 'Message' => ['title' => '响应消息', 'description' => '响应消息', 'type' => 'string', 'example' => '每页最大100条！'], + 'Model' => [ + 'title' => '', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int64', 'example' => '36'], + 'TotalPage' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int64', 'example' => '76'], + 'PageSize' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], + 'PageNo' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int64', 'example' => '47'], + 'Records' => [ + 'title' => '', + 'description' => '返回数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '绑定状态：绑定；未绑定', 'description' => '绑定状态：绑定；未绑定', 'type' => 'string', 'example' => '绑定'], + 'SceneId' => ['title' => '场景ID', 'description' => '场景ID', 'type' => 'integer', 'format' => 'int64', 'example' => '29'], + 'GmtCreate' => ['title' => '创建时间（时间戳）', 'description' => '创建时间（时间戳）', 'type' => 'string', 'example' => '1759109856000'], + 'SceneName' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'example' => '系统通知'], + 'InstanceStatus' => ['title' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', 'description' => '实例状态（init：初始化；usable：可用；unusable：不可用；destory：注销）', 'type' => 'string', 'example' => 'init'], + 'RelationTotalCount' => ['title' => '关联总数量', 'description' => '关联总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], + 'UsageId' => ['title' => '用途ID', 'description' => '用途ID', 'type' => 'integer', 'format' => 'int64', 'example' => '96'], + 'Code' => ['title' => '服务实例号', 'description' => '服务实例号', 'type' => 'string', 'example' => '0571****1234'], + 'RelationAvailableCount' => ['title' => '关联可用数量', 'description' => '关联可用数量', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'AliUid' => ['title' => 'aliUid', 'description' => 'aliUid', 'type' => 'integer', 'format' => 'int64', 'example' => '11******123'], + 'Name' => ['title' => '服务实例名称', 'description' => '服务实例名称', 'type' => 'string', 'example' => '测试数据'], + 'UsageName' => ['title' => '用途名称', 'description' => '用途名称', 'type' => 'string', 'example' => '语音通知'], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => ['title' => '状态码，OK表示响应成功', 'description' => '状态码，OK表示响应成功', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\" ED18A5AE-9BBC-5851-1111-8E5B8C23CEDE\\",\\n \\"Message\\": \\"每页最大100条！\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 36,\\n \\"TotalPage\\": 76,\\n \\"PageSize\\": 59,\\n \\"PageNo\\": 47,\\n \\"Records\\": [\\n {\\n \\"Status\\": \\"绑定\\",\\n \\"SceneId\\": 29,\\n \\"GmtCreate\\": \\"1759109856000\\",\\n \\"SceneName\\": \\"系统通知\\",\\n \\"InstanceStatus\\": \\"init\\",\\n \\"RelationTotalCount\\": 33,\\n \\"UsageId\\": 96,\\n \\"Code\\": \\"0571****1234\\",\\n \\"RelationAvailableCount\\": 30,\\n \\"AliUid\\": 0,\\n \\"Name\\": \\"测试数据\\",\\n \\"UsageName\\": \\"语音通知\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '分页查询服务实例列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [], + ], + 'PauseVideoFile' => [ + 'summary' => '在语音通话中插播视频文件时，暂停视频播放。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OperatorMobileVerifyCode', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201533', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '经办人手机验证码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****'], ], [ - 'name' => 'OperatorIdentityCard', + 'name' => 'CalledNumber', 'in' => 'query', + 'schema' => ['description' => '暂停视频播放的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '经办人身份证号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5****************9', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回结果详情。', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '本次请求是否成功调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '暂停视频', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PauseVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'PlayVideoFile' => [ + 'summary' => '在语音通话中插播视频文件。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Agreement', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '201522', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + ], + 'parameters' => [ + [ + 'name' => 'VideoId', 'in' => 'query', - 'schema' => [ - 'description' => '确认承诺书真实性。取值：'."\n" - ."\n" - .'- **true**：真实。'."\n" - .'- **false**：不真实。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '视频插播文件ID。'."\n" + ."\n" + .'您可以在[视频插播文件](https://dyvms.console.aliyun.com/videoFiles/list/slot)页面查看审核通过的视频ID。', 'type' => 'string', 'required' => true, 'example' => '1120213841979436_20240620155*****5_.mp4'], ], [ - 'name' => 'HotlineNumber', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '400号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => '接收视频播放的手机号码。', 'type' => 'string', 'required' => false, 'example' => '159****0000'], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => '通话一ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。'."\n" + ."\n" + .'> 您可以使用CallId，调用[QueryVideoPlayProgress](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-queryvideoplayprogress?spm)接口查看视频播放进度。', 'type' => 'string', 'required' => false, 'example' => '116012354148^1028137841****'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度限制为1~15个字符。', 'type' => 'string', 'required' => false, 'example' => '342268*****'], + ], + [ + 'name' => 'OnlyPhone', + 'in' => 'query', + 'schema' => ['description' => '仅在手机端播放视频。取值：'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false（默认值）', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '备案ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2258****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Model' => ['description' => '通话类型。'."\n" + ."\n" + .'- video'."\n" + ."\n" + .'- voice', 'type' => 'boolean', 'example' => 'video'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回**OK**代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Mobile.Invalid', - 'errorMessage' => 'The mobile number is invalid.', - ], - [ - 'errorCode' => 'MobileVerifyCode.Invalid', - 'errorMessage' => 'The mobile verification code is invalid.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '插播视频', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PlayVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PlayVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","type":"json"}]', - 'title' => '提交号码备案', - 'summary' => '您在设置400号码转呼号码前，需要对转呼的号码提交号码备案。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'SetTransferCalleePoolConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryCallDetailByCallId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'abilityTreeCode' => '52694', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], ], 'parameters' => [ [ - 'name' => 'Details', + 'name' => 'CallId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => '通话的唯一识别ID。调用外呼接口发起通话后，返回参数中会携带CallId。'."\n" + .' - 获取的CallId与**QueryDate**必须是同一天。示例：CallId的时间是2022.11.21，**QueryDate**必须也是2022.11.21内的时间。'."\n" + .' - 获取的CallId与**ProdId**参数值必须匹配。示例：CallId是在发送语音通知后获取的，那**ProdId**参数需要填写语音通知产品ID即**11000000300006**。', 'type' => 'string', 'required' => true, 'example' => '116014888060^10281631****'], + ], + [ + 'name' => 'ProdId', + 'in' => 'query', + 'schema' => ['description' => '产品ID。取值：'."\n" + .'- **11000000300006**：语音通知。'."\n" + .'- **11010000138001**：语音验证码。'."\n" + .'- **11000000300005**：语音IVR，向指定号码发起交互式语音通话。'."\n" + .'- **11000000300009**：语音SIP。'."\n" + .'- **11030000180001**：智能外呼。'."\n" + ."\n" + .'> 获取的CallId与**ProdId**参数值必须匹配，不匹配或传入错误的产品ID将无法返回**Data**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11000000300006'], + ], + [ + 'name' => 'QueryDate', + 'in' => 'query', + 'schema' => ['description' => '通话发生的时间。格式为Unix时间戳，单位：毫秒。'."\n" + ."\n" + .'查询指定时间点之后24小时内的通话记录。'."\n" + ."\n" + .'例如：您输入2022.11.21 20:00:01（时间戳：1669032001000），系统会查询2022.11.21 20:00:01~2022.11.22 20:00:01时间段内指定CallId的呼叫记录。'."\n" + ."\n" + .'> 获取的CallId与**QueryDate**必须是同一天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1669032001000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '呼转号码信息。', - 'type' => 'array', - 'items' => [ - 'description' => '呼转号码信息。', - 'type' => 'object', - 'properties' => [ - 'Caller' => [ - 'description' => '主叫号码。', - 'type' => 'string', - 'required' => false, - 'example' => '150****0000', - ], - 'Called' => [ - 'description' => '被叫号码。已备案的号码。'."\n" - ."\n" - .'您可以通过[SubmitHotlineTransferRegister](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-submithotlinetransferregister?spm=a2c4g.11186623.0.0.7b784120BH0XPT)接口，提交号码备案。', - 'type' => 'string', - 'required' => true, - 'example' => '151****0000', - ], - ], - 'required' => false, + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '返回的呼叫详情。JSON格式。以下字段仅供参考，以具体返回详情为准。'."\n" + .'- **caller**：主叫号码。'."\n" + .'- **startDate**：通话开始时间。'."\n" + .'- **stateDesc**：通话状态描述。'."\n" + .'- **duration**：通话时长。单位：秒。**0**：用户未接通。'."\n" + .'- **callerShowNumber**：被叫显号。'."\n" + .'- **gmtCreate**：通话请求的接收时间。'."\n" + .'- **state**：通话状态。通话状态是运营商实时返回的，更多状态信息，请参见[运营商回执错误码](~~55085~~)。'."\n" + .'- **endDate**：通话结束时间。'."\n" + .'- **calleeShowNumber**：被叫显号。'."\n" + .'- **callee**：被叫号码。'."\n" + .'- **aRingTime**：a路响铃开始时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" + .'- **aEndTime**：a路响铃结束时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" + .'- **bRingTime**：b路响铃开始时间。格式：yyyy-MM-dd HH:mm:ss。'."\n" + .'- **bEndTime**：b路响铃结束时间。格式：yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'example' => '{"caller":"18767****","startDate":"","stateDesc":"502","duration":0,"callerShowNumber":"05344****","gmtCreate":"2017-11-27 20:09:06","state":"502","endDate":"","calleeShowNumber":"053447****","bRingTime":"2022-01-01 12:02:00","bEndTime":"2022-01-01 12:02:28","callee":"1373546****"}'], + 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], ], - 'required' => true, - 'maxItems' => 10, ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"caller\\\\\\":\\\\\\"18767****\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"\\\\\\",\\\\\\"stateDesc\\\\\\":\\\\\\"502\\\\\\",\\\\\\"duration\\\\\\":0,\\\\\\"callerShowNumber\\\\\\":\\\\\\"05344****\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2017-11-27 20:09:06\\\\\\",\\\\\\"state\\\\\\":\\\\\\"502\\\\\\",\\\\\\"endDate\\\\\\":\\\\\\"\\\\\\",\\\\\\"calleeShowNumber\\\\\\":\\\\\\"053447****\\\\\\",\\\\\\"bRingTime\\\\\\":\\\\\\"2022-01-01 12:02:00\\\\\\",\\\\\\"bEndTime\\\\\\":\\\\\\"2022-01-01 12:02:28\\\\\\",\\\\\\"callee\\\\\\":\\\\\\"1373546****\\\\\\"}\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryCallDetailByCallIdResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>{\\"caller\\":\\"18767****\\",\\"startDate\\":\\"\\",\\"stateDesc\\":\\"502\\",\\"duration\\":0,\\"callerShowNumber\\":\\"05344****\\",\\"gmtCreate\\":\\"2017-11-27 20:09:06\\",\\"state\\":\\"502\\",\\"endDate\\":\\"\\",\\"calleeShowNumber\\":\\"053447****\\",\\"bRingTime\\":\\"2022-01-01 12:02:00\\"，\\"bEndTime\\":\\"2022-01-01 12:02:28\\"，\\"callee\\":\\"1373546****\\"}</Data>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n</QueryCallDetailByCallIdResponse>","errorExample":""}]', + 'title' => '查询指定通话的呼叫详情', + 'summary' => '根据指定通话任务返回的CallID查询呼叫详情，包括通话开始时间、通话时长、通话状态、通话结束时间、被叫号码等详情。', + 'description' => '- 此接口只支持查询近6个月的数据。'."\n" + .'- 此接口可查询语音通知、语音验证码、语音IVR、智能语音交互、智能外呼机器人的呼叫详情。'."\n" + .'- 由于接口数据同步需要时间，建议您呼叫结束后等待3到5分钟再尝试调用接口。'."\n" + .'- 调用外呼接口发起通话后，返回参数中会携带CallId，使用获取的CallID查询呼叫详情。例：如果您需要查询语音通知的通话记录，请调用[SingleCallByVoice](~~393517~~)发送语音通知后获取CallId。'."\n" + .'- 请求参数**ProdId**和**QueryDate**必须与**CallID**匹配，否则查询到的呼叫详情可能为空。详细匹配规则请参见请求参数描述。'."\n" + .'- 呼叫详情记录不支持跨账号查询，请确保调用本接口的账号与发送外呼通话的账号一致。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByCallId'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByCallId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryCallDetailByTaskId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PhoneNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '呼转号码。'."\n" - ."\n" - .'您已在[语音服务控制台真实号码管理页面](https://dyvms.console.aliyun.com/number/list/400)购买的400号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400903****', - ], + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID，成功下发机器人外呼任务后返回。可以在语音控制台[任务管理](https://dyvms.console.aliyun.com/job/list)中查看，或调用接口**BatchRobotSmartCall**成功后记录返回的参数**TaskId**。', 'type' => 'string', 'required' => true, 'example' => '4001112222'], ], [ - 'name' => 'QualificationId', + 'name' => 'QueryDate', 'in' => 'query', - 'schema' => [ - 'description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '190***', - ], + 'schema' => ['description' => '机器人外呼任务的开始时间。Unix时间戳格式，单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2020-10-09 09:02:03'], ], [ - 'name' => 'CalledRouteMode', + 'name' => 'Callee', 'in' => 'query', - 'schema' => [ - 'description' => '呼叫模式。取值：'."\n" - ."\n" - .'- **roundRobin**：轮询。'."\n" - .'- **random**：随机。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'roundRobin', - ], + 'schema' => ['description' => '被叫号码。当前仅支持查看一个被叫号码的外呼记录。', 'type' => 'string', 'required' => true, 'example' => '1390000****'], ], ], 'responses' => [ @@ -5377,59 +10648,77 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '转呼号码配置详情。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'E7518CE1-B0FF-4C6F-9252-BF80271B2F99', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人外呼任务的话单详情，JSON格式。参数包括：'."\n" + .'- **startDate**：应答时间。'."\n" + .'- **stateDesc**：挂机原因，有早媒体状态码的情况下，使用早媒体码的原因。'."\n" + .'- **statusCode**：状态码。'."\n" + .'- **endDate**：结束时间。'."\n" + .'- **calleeShowNumber**：主叫号显。'."\n" + .'- **callee**：被叫号码。'."\n" + .'- **duration**：计费时长。'."\n" + .'- **gmtCreate**：创建时间。'."\n" + .'- **hangupDirection**：挂机方向。'."\n" + .'- **tags**：标签。'."\n" + .'- **dialogCount**：对话轮次。'."\n" + .'- **sureCount**：肯定次数。'."\n" + .'- **denyCount**：否定次数。'."\n" + .'- **rejectCount**：拒绝次数。'."\n" + .'- **customCount**：自定义次数。'."\n" + .'- **knowledgeCount**：知识库次数。'."\n" + .'- **recordFile**：录音文件下载地址，URL的过期时间为48小时，请及时下载。'."\n" + .'- **callId**：通话ID。'."\n" + .'- **recordStatus**：录音文件状态。其中：'."\n" + .' - 1：有录音文件。'."\n" + .' - 2：没有录音文件。'."\n" + .'- **knowledgeCommonCount**：知识库通用问题字数。'."\n" + .'- **knowledgeBusinessCount**：知识库业务问题字数。'."\n" + .'- **callee**：被叫号码。'."\n" + .'- **dialogDetail**：对话明细，一个JSON数组。其中包括：'."\n" + .' - **role**：发言对象。'."\n" + .' - **content**：发言内容。'."\n" + .' - **time**：发言时间。'."\n" + ."\n" + .'> 返回字段供参考，具体字段以实际返回参数为准。', 'type' => 'string', 'example' => '{"rejectCount":0,"dialogCount":3,"tags":"","startDate":"2019-03-27 10:34:54","gmtCreate":"2019-03-27 10:34:40","sureCount":0,"state":"200000","recordFile":"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQuk%3D&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"1390000****","customCount":0,"callId":"1390000****","knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"1390000****","knowledgeBusinessCount":0,"hangupDirection":1}'."\n"], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D86B61A8-F2EE-4E4C-9F05-08A4676FFD89'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E7518CE1-B0FF-4C6F-9252-BF80271B2F99\\"\\n}","type":"json"}]', - 'title' => '设置400号码呼转', - 'summary' => '为400号码设置转呼号码。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：100次/秒。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"rejectCount\\\\\\":0,\\\\\\"dialogCount\\\\\\":3,\\\\\\"tags\\\\\\":\\\\\\"\\\\\\",\\\\\\"startDate\\\\\\":\\\\\\"2019-03-27 10:34:54\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"2019-03-27 10:34:40\\\\\\",\\\\\\"sureCount\\\\\\":0,\\\\\\"state\\\\\\":\\\\\\"200000\\\\\\",\\\\\\"recordFile\\\\\\":\\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQuk%3D&Expires=1554382725\\\\\\",\\\\\\"defaultCount\\\\\\":0,\\\\\\"endDate\\\\\\":\\\\\\"2019-03-27 10:35:09\\\\\\",\\\\\\"calleeShowNumber\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"customCount\\\\\\":0,\\\\\\"callId\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"knowledgeCount\\\\\\":0,\\\\\\"recordStatus\\\\\\":1,\\\\\\"denyCount\\\\\\":0,\\\\\\"duration\\\\\\":16,\\\\\\"knowledgeCommonCount\\\\\\":0,\\\\\\"callee\\\\\\":\\\\\\"1390000****\\\\\\",\\\\\\"knowledgeBusinessCount\\\\\\":0,\\\\\\"hangupDirection\\\\\\":1}\\\\n\\",\\n \\"RequestId\\": \\"D86B61A8-F2EE-4E4C-9F05-08A4676FFD89\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryCallDetailByTaskIdResponse>\\r\\n \\t<Data>{"rejectCount":0,"dialogCount":3,"tags":1,"startDate":"2019-03-27 10:34:54","gmtCreate":"2019-03-27 10:34:40","sureCount":0,"state":"200000","recordFile":"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_115987800002_02c3554f-ea24-422d-b1de-e671f455f21a_record.wav?OSSAccessKeyId=bypFNbGJVk73****&Signature=VWHOX%2FFhvvtSkxfMTw%2F5fdJUQu****&Expires=1554382725","defaultCount":0,"endDate":"2019-03-27 10:35:09","calleeShowNumber":"053158552960","customCount":0,"callId":"115987800002^102789420002","dialogDetail":[{"content":"我的呼叫测试","startTime":"Wed Mar 27 10:34:45 CST 2019","role":"robot"},{"content":"喂，哎，你好","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"custom"},{"content":"不好意思，可以慢点再说一遍吗?","startTime":"Wed Mar 27 10:35:00 CST 2019","role":"robot"},{"content":"喂","startTime":"Wed Mar 27 10:35:01 CST 2019","role":"custom"},{"content":"哦再见","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"custom"},{"content":"不好意思，我这边听得不是很清楚，您可以再说一遍吗？","startTime":"Wed Mar 27 10:35:08 CST 2019","role":"robot"}],"knowledgeCount":0,"recordStatus":1,"denyCount":0,"duration":16,"knowledgeCommonCount":0,"callee":"13735460951","knowledgeBusinessCount":0,"hangupDirection":1}</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D86B61A8-F2EE-4E4C-9F05-08A4676FFD89</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryCallDetailByTaskIdResponse>","errorExample":""}]', + 'title' => '查看指定机器人外呼任务的话单详情', + 'summary' => '查看指定机器人外呼任务的话单详情。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByTaskId'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByTaskId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryCallInPoolTransferConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5437,22 +10726,14 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '您已购买的400号码。'."\n" - ."\n" - .'您可以在[语音服务控制台真实号管理](https://dyvms.console.aliyun.com/number/list/400)页面查看400号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400903****', - ], + 'schema' => ['description' => '您已购买的400号码。'."\n" + ."\n" + .'您可以在[语音服务控制台真实号管理](https://dyvms.console.aliyun.com/number/list/400)页面查看400号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400903****'], ], ], 'responses' => [ @@ -5461,59 +10742,31 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'GmtCreate' => [ - 'description' => '创建时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1623137002000', - ], - 'CalledRouteMode' => [ - 'description' => '呼叫模式。取值：'."\n" - ."\n" - .'- **roundRobin**：轮询。'."\n" - .'- **random**：随机。', - 'type' => 'string', - 'example' => 'random', - ], - 'TransferTimeout' => [ - 'description' => '超时时长。', - 'type' => 'string', - 'example' => '30', - ], + 'GmtCreate' => ['description' => '创建时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1623137002000'], + 'CalledRouteMode' => ['description' => '呼叫模式。取值：'."\n" + ."\n" + .'- **roundRobin**：轮询。'."\n" + .'- **random**：随机。', 'type' => 'string', 'example' => 'random'], + 'TransferTimeout' => ['description' => '超时时长。', 'type' => 'string', 'example' => '30'], 'Details' => [ 'description' => '返回结果详情。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Called' => [ - 'description' => '呼转号码。', - 'type' => 'string', - 'example' => '400903****', - ], + 'Called' => ['description' => '呼转号码。', 'type' => 'string', 'example' => '400903****'], ], + 'description' => '', ], ], ], @@ -5524,10 +10777,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"GmtCreate\\": 1623137002000,\\n \\"CalledRouteMode\\": \\"random\\",\\n \\"TransferTimeout\\": \\"30\\",\\n \\"Details\\": [\\n {\\n \\"Called\\": \\"400903****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCallInPoolTransferConfigResponse>\\n<Message>OK</Message>\\n<RequestId>7BF47617-7851-48F7-A3A1-2021342A78E2</RequestId>\\n<Data>\\n <GmtCreate>1623137002000</GmtCreate>\\n <CalledRouteMode>random</CalledRouteMode>\\n <TransferTimeout>30</TransferTimeout>\\n <Details>\\n <Called>400****</Called>\\n </Details>\\n</Data>\\n<Code>OK</Code>\\n</QueryCallInPoolTransferConfigResponse>","errorExample":""}]', @@ -5540,16 +10790,30 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInPoolTransferConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInPoolTransferConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], 'QueryCallInTransferRecord' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5559,68 +10823,35 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '52697', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '呼转号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '400****', - ], + 'schema' => ['description' => '呼转号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****'], ], [ 'name' => 'CallInCaller', 'in' => 'query', - 'schema' => [ - 'description' => '呼入主叫。', - 'type' => 'string', - 'required' => false, - 'example' => '150****0000', - ], + 'schema' => ['description' => '呼入主叫。', 'type' => 'string', 'required' => false, 'example' => '150****0000'], ], [ 'name' => 'QueryDate', 'in' => 'query', - 'schema' => [ - 'description' => '查询时间。格式：YYYY-MM-DD hh:mm:ss。'."\n" - ."\n" - .'> 查询结果为当天的所有的呼转记录。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-28 00:00:00', - ], + 'schema' => ['description' => '查询时间。格式：YYYY-MM-DD hh:mm:ss。'."\n" + ."\n" + .'> 查询结果为当天的所有的呼转记录。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-28 00:00:00'], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '页码。默认取值为**1**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '页码。默认取值为**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '页数。取值范围：**1~10**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => '页数。取值范围：**1~10**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10'], ], ], 'responses' => [ @@ -5629,84 +10860,33 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7BF47617-7851-48F7-A3A1-2021342A78E2'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'PageNo' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], + 'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], 'Values' => [ 'description' => '呼转记录。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'CallInCalled' => [ - 'description' => '呼入被叫。', - 'type' => 'string', - 'example' => '150****0000', - ], - 'TransferCalled' => [ - 'description' => '呼转被叫。', - 'type' => 'string', - 'example' => '151****0000', - ], - 'RecordUrl' => [ - 'description' => '录音地址。', - 'type' => 'string', - 'example' => 'http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D', - ], - 'TransferCaller' => [ - 'description' => '呼转主叫。', - 'type' => 'string', - 'example' => '151****0000', - ], - 'GmtCreate' => [ - 'description' => '呼叫时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2020-10-03 10:21:21', - ], - 'CallInCaller' => [ - 'description' => '呼入主叫。', - 'type' => 'string', - 'example' => '150****0000', - ], + 'CallInCalled' => ['description' => '呼入被叫。', 'type' => 'string', 'example' => '150****0000'], + 'TransferCalled' => ['description' => '呼转被叫。', 'type' => 'string', 'example' => '151****0000'], + 'RecordUrl' => ['description' => '录音地址。', 'type' => 'string', 'example' => 'http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D'], + 'TransferCaller' => ['description' => '呼转主叫。', 'type' => 'string', 'example' => '151****0000'], + 'GmtCreate' => ['description' => '呼叫时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2020-10-03 10:21:21'], + 'CallInCaller' => ['description' => '呼入主叫。', 'type' => 'string', 'example' => '150****0000'], ], + 'description' => '', ], ], ], @@ -5717,10 +10897,7 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A78E2\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"Values\\": [\\n {\\n \\"CallInCalled\\": \\"150****0000\\",\\n \\"TransferCalled\\": \\"151****0000\\",\\n \\"RecordUrl\\": \\"http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684****.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73****&Signature=****mUqkPqIQ%3D\\",\\n \\"TransferCaller\\": \\"151****0000\\",\\n \\"GmtCreate\\": 0,\\n \\"CallInCaller\\": \\"150****0000\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCallInTransferRecordResponse>\\n<Message>OK</Message>\\n<RequestId>7BF47617-7851-48F7-A3A1-2021342A78E2</RequestId>\\n<Data>\\n <PageSize>20</PageSize>\\n <Total>50</Total>\\n <PageNo>1</PageNo>\\n <Values>\\n <GmtCreate>1624865503000</GmtCreate>\\n <CallInCalled>150****0000</CallInCalled>\\n <RecordUrl>http://alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/dayuBizVoiceMrg/4238c230-9e74-41be-90b8-2fbe7684eea0.wav?Expires=1627538265&OSSAccessKeyId=bypFNbGJVk73PsLI&Signature=****mUqkPqIQ%3D</RecordUrl>\\n <TransferCaller>151****0000</TransferCaller>\\n <TransferCalled>151****0000</TransferCalled>\\n <CallInCaller>150****0000</CallInCaller>\\n </Values>\\n</Data>\\n<Code>OK</Code>\\n</QueryCallInTransferRecordResponse>","errorExample":""}]', @@ -5731,318 +10908,898 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' 无', - ], - 'SendVerification' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInTransferRecord'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInTransferRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryRobotInfoList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52709', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'VerifyType', + 'name' => 'AuditStatus', 'in' => 'query', + 'schema' => ['description' => '审核状态，取值：'."\n" + .'- **CONFIGURABLE**：可配置。'."\n" + .'- **AUDITING**：审核中 。'."\n" + .'- **AUDITPASS**：审核通过。'."\n" + .'- **AUDITFAIL**：审核失败。', 'type' => 'string', 'required' => false, 'example' => 'AUDITING'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '短信验证码发送类型。固定取值：**SMS**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SMS', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人的基本信息，JSON格式。参数如下：'."\n" + .'- **id**：机器人id。'."\n" + .'- **robotName**：机器人名称。'."\n" + .'- **robotType**：机器人类型。'."\n" + .'- **auditStatus**：审核状态。'."\n" + .'- **gmtCreate**：创建时间。'."\n" + .'- **gmtModified**：修改时间。'."\n" + .'- **partnerId**：合作伙伴ID。'."\n" + .'- **asrId**：ASR模型ID。'."\n" + .'- **asrType**：ASR类型，包括**公有**和**私有**。'."\n" + .'- **remark**：备注说明。', 'type' => 'string', 'example' => '{["id":1000010920004, "gmtModified":"Thu Mar 21 15:38:55 CST 2019", "auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 12:00:51 CST 2019","remark":"测试勿删，测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5--ssml标记2-RVR-副本"},{"id":1000010920003,"gmtModified":"Thu Mar 21 11:51:10 CST 2019","auditStatus":"AUDITPASS","gmtCreate":"Thu Mar 21 11:44:57 CST 2019","remark":"测试勿删，内部测试请通过","partnerId":100000022670001,"asrId":"a9a1d69081fd4266ad788346bf5e1b6c","robotType":"CUSTOM","asrType":"1","robotName":"催收场景5-ssml标记2-RVR"]}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F59AF338-655D-48E8-9471-5EB07692B1CC'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{[\\\\\\"id\\\\\\":1000010920004, \\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 15:38:55 CST 2019\\\\\\", \\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 12:00:51 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5--ssml标记2-RVR-副本\\\\\\"},{\\\\\\"id\\\\\\":1000010920003,\\\\\\"gmtModified\\\\\\":\\\\\\"Thu Mar 21 11:51:10 CST 2019\\\\\\",\\\\\\"auditStatus\\\\\\":\\\\\\"AUDITPASS\\\\\\",\\\\\\"gmtCreate\\\\\\":\\\\\\"Thu Mar 21 11:44:57 CST 2019\\\\\\",\\\\\\"remark\\\\\\":\\\\\\"测试勿删，内部测试请通过\\\\\\",\\\\\\"partnerId\\\\\\":100000022670001,\\\\\\"asrId\\\\\\":\\\\\\"a9a1d69081fd4266ad788346bf5e1b6c\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\",\\\\\\"asrType\\\\\\":\\\\\\"1\\\\\\",\\\\\\"robotName\\\\\\":\\\\\\"催收场景5-ssml标记2-RVR\\\\\\"]}\\",\\n \\"RequestId\\": \\"F59AF338-655D-48E8-9471-5EB07692B1CC\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<QueryRobotInfoListResponse>\\r\\n\\t<Data>[{\\"id\\":1000010920004,\\"gmtModified\\":\\"Thu Mar 21 15:38:55 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 12:00:51 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景5-ssml标记2-RVR-副本\\"},{\\"id\\":1000010920003,\\"gmtModified\\":\\"Thu Mar 21 11:51:10 CST 2019\\",\\"auditStatus\\":\\"AUDITPASS\\",\\"gmtCreate\\":\\"Thu Mar 21 11:44:57 CST 2019\\",\\"remark\\":\\"测试勿删，测试请通过\\",\\"partnerId\\":100000022670001,\\"asrId\\":\\"a9a1d69081fd4266ad788346bf5e1b6c\\",\\"robotType\\":\\"CUSTOM\\",\\"asrType\\":\\"1\\",\\"robotName\\":\\"催收场景-ssml标记2-RVR\\"}}]</Data>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>E8EF9B41-C4DC-44D5-A25B-DA9AC7791998</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QueryRobotInfoListResponse>","errorExample":""}]', + 'title' => '查询智能语音机器人列表', + 'summary' => '查看智能语音机器人列表，获取机器人详细信息。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotInfoList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + ], + 'QueryRobotTaskCallDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BizType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '业务类型。固定取值：**CONTACT**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CONTACT', - ], + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001'], ], [ - 'name' => 'Target', + 'name' => 'Callee', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '130****0000'], + ], + [ + 'name' => 'QueryDate', 'in' => 'query', + 'schema' => ['description' => '查询时间，请使用时间戳格式。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1603239801000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '接收短信验证码的手机号码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '150****0000', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '智能语音任务通话详情，JSON格式。'."\n" + .'- **taskId**：机器人呼叫任务的唯一任务ID。'."\n" + .'- **caller**：主叫号码。'."\n" + .'- **called**：被叫号码。'."\n" + .'- **duration**：通话时长。单位：秒。'."\n" + .'- **label**：标签。'."\n" + .'- **dialogCount**：对话轮次。'."\n" + .'- **callResult**：通话结果。'."\n" + .'- **hangupDirection**：挂断方向。**0**：机器人。**1**：用户。'."\n" + .'- **transferResult**：转接人工状态。**1**：转接成功，**0**：转接失败，**3**：未转人工。'."\n" + .'- **transferNumber**：人工座席号码。'."\n" + .'- **transferFailReson**：转接人工失败原因。'."\n" + .'- **callId**：通话的唯一回执ID。组成形成：`taskId+^+bizId`。'."\n" + .'- **recallCurTimes**：重试次数。'."\n" + .'- **callStartTime**：通话开始时间。'."\n" + .'- **callEndTime**：通话结束时间。'."\n" + .'- **sureCount**：肯定次数。'."\n" + .'- **denyCount**：否定次数。'."\n" + .'- **rejectCount**：拒绝次数。'."\n" + .'- **customCount**：自定义次数。'."\n" + .'- **knowledgeCount**：知识库次数。'."\n" + .'- **defaultCount**：默认次数。'."\n" + .'- **knowledgeBusinessCount**：业务问题次数。'."\n" + .'- **knowledgeCommonCount**：通用问题次数。'."\n" + .'- **recordStatus**：录音文件状态。**1**：有录音文件；**2**：没有录音文件。'."\n" + .'- **recordFile**：录音文件下载地址。'."\n" + .'- **dialogDetail**：对话明细，Json数组。**role**：发言对象；**content**：发言内容；**speakTime**：发言时间。'."\n", 'type' => 'string', 'example' => '{ "taskId" : 1045001, "caller" : "0571-8899****", "called" : "130****0000", "duration" : "60", "label" : "邀约，有房，无车", "dialogCount": "3", "callResult" : "无法接通", "hangupDirection" : "1", "transferResult" : "3", "transferNumber" ：0571-8833****, "transferFailReason" ："用户挂断", "callId" ："116950320375^10375010****", "recallCurTimes" : 2, "callStartTime" : "2019.06.14 15:22:23", "callEndTime" : "2019.06.14 15:22:55", "sureCount" : 2, "denyCount" : 2, "rejectCount" : 0, "customCount" : 0, "knowledgeCount" : 0, "defaultCount" : 0, "knowledgeBusinessCount" : 0, "knowledgeCommonCount" : 0, "recordStatus":1, "recordFile": "http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******", "dialogDetail": [{"role": "robot","speakTime": "2019-06-19 20:44:17","content":"开场白"}] }'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + ], ], ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{ \\\\\\"taskId\\\\\\" : 1045001, \\\\\\"caller\\\\\\" : \\\\\\"0571-8899****\\\\\\", \\\\\\"called\\\\\\" : \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\" : \\\\\\"60\\\\\\", \\\\\\"label\\\\\\" : \\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\": \\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\" : \\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\" : \\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\" : \\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\" ：0571-8833****, \\\\\\"transferFailReason\\\\\\" ：\\\\\\"用户挂断\\\\\\", \\\\\\"callId\\\\\\" ：\\\\\\"116950320375^10375010****\\\\\\", \\\\\\"recallCurTimes\\\\\\" : 2, \\\\\\"callStartTime\\\\\\" : \\\\\\"2019.06.14 15:22:23\\\\\\", \\\\\\"callEndTime\\\\\\" : \\\\\\"2019.06.14 15:22:55\\\\\\", \\\\\\"sureCount\\\\\\" : 2, \\\\\\"denyCount\\\\\\" : 2, \\\\\\"rejectCount\\\\\\" : 0, \\\\\\"customCount\\\\\\" : 0, \\\\\\"knowledgeCount\\\\\\" : 0, \\\\\\"defaultCount\\\\\\" : 0, \\\\\\"knowledgeBusinessCount\\\\\\" : 0, \\\\\\"knowledgeCommonCount\\\\\\" : 0, \\\\\\"recordStatus\\\\\\":1, \\\\\\"recordFile\\\\\\": \\\\\\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\\\\\", \\\\\\"dialogDetail\\\\\\": [{\\\\\\"role\\\\\\": \\\\\\"robot\\\\\\",\\\\\\"speakTime\\\\\\": \\\\\\"2019-06-19 20:44:17\\\\\\",\\\\\\"content\\\\\\":\\\\\\"开场白\\\\\\"}] }\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskCallDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>{ \\"taskId\\" : 1045001, \\"caller\\" : \\"0571-8899****\\", \\"called\\" : \\"130****0000\\", \\"duration\\" : \\"60\\", \\"label\\" : \\"邀约，有房，无车\\", \\"dialogCount\\": \\"3\\", \\"callResult\\" : \\"无法接通\\", \\"hangupDirection\\" : \\"1\\", \\"transferResult\\" : \\"3\\", \\"transferNumber\\" ：0571-8833****, \\"transferFailReason\\" ：\\"用户挂断\\", \\"callId\\" ：\\"116950320375^10375010****\\", \\"recallCurTimes\\" : 2, \\"callStartTime\\" : \\"2019.06.14 15:22:23\\", \\"callEndTime\\" : \\"2019.06.14 15:22:55\\", \\"sureCount\\" : 2, \\"denyCount\\" : 2, \\"rejectCount\\" : 0, \\"customCount\\" : 0, \\"konwledgeCount\\" : 0, \\"defaultCount\\" : 0, \\"knowledgeBusinessCount\\" : 0, \\"knowledgeCommonCount\\" : 0, \\"recordStatus\\":1, \\"recordFile\\": \\"http://alicom-fc-record-biz.cn-hangzhou.oss.aliyun-inc.com/Freeswitch_RU_117074080001_ccd71132-8256-4eb4-9217-884e1d87c0d4_record.wav?Expires=1562740186&OSSAccessKeyId=bypFNbGJVk7****&Signature=99losPmytVl%2BMH85noZGD******\\", \\"dialogDetail\\": [{\\"role\\": \\"robot\\",\\"speakTime\\": \\"2019-06-19 20:44:17\\",\\"content\\":\\"开场白\\"}] }</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallDetailResponse>","errorExample":""}]', + 'title' => '查询智能机器人任务执行详情', + 'summary' => '获取单个执行条目即单个被叫号码的任务明细。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryRobotTaskCallList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~393531~~)接口获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1045001****'], + ], + [ + 'name' => 'DurationFrom', + 'in' => 'query', + 'schema' => ['description' => '通话时长，左边数值。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'DurationTo', + 'in' => 'query', + 'schema' => ['description' => '通话时长，右边数值。', 'type' => 'string', 'required' => false, 'example' => '60'], + ], + [ + 'name' => 'DialogCountFrom', + 'in' => 'query', + 'schema' => ['description' => '对话轮次，左边数值。', 'type' => 'string', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'DialogCountTo', + 'in' => 'query', + 'schema' => ['description' => '对话轮次，右边数值。', 'type' => 'string', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'HangupDirection', + 'in' => 'query', + 'schema' => ['description' => '挂断方向。取值：'."\n" + ."\n" + .'- **0**：用户。'."\n" + .'- **1**：机器人。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallResult', + 'in' => 'query', + 'schema' => ['description' => '通话结果。取值：'."\n" + .'- **200002**：占线。'."\n" + .'- **200005**：无法接通。'."\n" + .'- **200010**：关机。'."\n" + .'- **200011**：停机。'."\n" + .'- **200012**：呼损。', 'type' => 'string', 'required' => false, 'example' => '200002'], + ], + [ + 'name' => 'Called', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。', 'type' => 'string', 'required' => false, 'example' => '1300****0000'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'description' => '验证码是否发送成功。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '智能语音任务通话列表，JSON数组格式。'."\n" + .'- **taskId**：机器人呼叫任务的唯一任务ID。'."\n" + .'- **caller**：主叫号码。'."\n" + .'- **called**：被叫号码。'."\n" + .'- **duration**：通话时长，单位：秒。'."\n" + .'- **label**：标签。'."\n" + .'- **dialogCount**：对话轮次。'."\n" + .'- **callResult**：通话结果。'."\n" + .'- **hangupDirection**：挂断方向。**1**：用户；**0**：机器人。'."\n" + .'- **transferResult**：转接人工状态。**1**：转接成功；**0**：转接失败；**3**：未转人工。'."\n" + .'- **transferNumber**：人工座席号码。'."\n" + .'- **transferFailReson**：转接人工失败原因。'."\n" + .'- **callId**：通话的唯一回执ID。'."\n" + .'- **recallCurTimes**：重试次数。'."\n" + .'- **callStartTime**：通话开始时间。'."\n" + .'- **callEndTime**：通话结束时间。'."\n" + .'- **sureCount**：肯定次数。'."\n" + .'- **denyCount**：否定次数。'."\n" + .'- **rejectCount**：拒绝次数。'."\n" + .'- **customCount**：用户自定义次数。'."\n" + .'- **konwledgeCount**：查询知识库次数。'."\n" + .'- **defaultCount**：默认次数。'."\n" + .'- **knowledgeBusinessCount**：业务问题次数。'."\n" + .'- **knowledgeCommonCount**：通用问题次数。', 'type' => 'string', 'example' => '[ {"taskId":"1045001", "caller":"0571-889****", "called": "130****0000", "duration":"60", "label":"邀约，有房，无车", "dialogCount":"3", "callResult":"无法接通", "hangupDirection":"1", "transferResult":"3", "transferNumber":"0571-8833****", "transferFailReason":"用户挂断", "callId":"116950320375^10375010****", "recallCurTimes":"2", "callStartTime":"2019.06.14 15:22:23", "callEndTime":"2019.06.14 15:22:55", "sureCount":"2", "denyCount":"2", "rejectCount":"0", "customCount:"0", "knowledgeCount":"0", "defaultCount":"0", "knowledgeBusinessCount":"0", "knowledgeCommonCount":"0"} ]'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"[ {\\\\\\"taskId\\\\\\":\\\\\\"1045001\\\\\\", \\\\\\"caller\\\\\\":\\\\\\"0571-889****\\\\\\", \\\\\\"called\\\\\\": \\\\\\"130****0000\\\\\\", \\\\\\"duration\\\\\\":\\\\\\"60\\\\\\", \\\\\\"label\\\\\\":\\\\\\"邀约，有房，无车\\\\\\", \\\\\\"dialogCount\\\\\\":\\\\\\"3\\\\\\", \\\\\\"callResult\\\\\\":\\\\\\"无法接通\\\\\\", \\\\\\"hangupDirection\\\\\\":\\\\\\"1\\\\\\", \\\\\\"transferResult\\\\\\":\\\\\\"3\\\\\\", \\\\\\"transferNumber\\\\\\":\\\\\\"0571-8833****\\\\\\", \\\\\\"transferFailReason\\\\\\":\\\\\\"用户挂断\\\\\\", \\\\\\"callId\\\\\\":\\\\\\"116950320375^10375010****\\\\\\", \\\\\\"recallCurTimes\\\\\\":\\\\\\"2\\\\\\", \\\\\\"callStartTime\\\\\\":\\\\\\"2019.06.14 15:22:23\\\\\\", \\\\\\"callEndTime\\\\\\":\\\\\\"2019.06.14 15:22:55\\\\\\", \\\\\\"sureCount\\\\\\":\\\\\\"2\\\\\\", \\\\\\"denyCount\\\\\\":\\\\\\"2\\\\\\", \\\\\\"rejectCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"customCount:\\\\\\"0\\\\\\", \\\\\\"knowledgeCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"defaultCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"knowledgeBusinessCount\\\\\\":\\\\\\"0\\\\\\", \\\\\\"knowledgeCommonCount\\\\\\":\\\\\\"0\\\\\\"} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskCallListResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>[ { “taskId” : 1045001， “caller” : “0571-889****”, “called” : “130****0000”, “duration” : “60”, “label” : “邀约，有房，无车”, “dialogCount” : “3”, “callResult” : “无法接通”, “hangupDirection” : “1”, “transferResult“ : “3”, “transferNumber” ：0571-8833****, “transferFailReason” ：“用户挂断”, “callId” ：“116950320375^10375010****”, “recallCurTimes” : 2, “callStartTime” : “2019.06.14 15:22:23”, “callEndTime” : “2019.06.14 15:22:55”, “sureCount” : 2, “denyCount” : 2, “rejectCount” : 0, “customCount” : 0, “konwledgeCount” : 0, “defaultCount” : 0, “knowledgeBusinessCount” : 0, “knowledgeCommonCount” : 0 } ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n</QueryRobotTaskCallListResponse>","errorExample":""}]', + 'title' => '查询任务内执行条目列表', + 'summary' => '查询指定任务内执行条目列表。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'errorCode' => 'Mobile.Invalid', - 'errorMessage' => 'The mobile number is invalid.', + ], + ], + ], + 'QueryRobotTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人任务详情信息。JSON格式。'."\n" + .'- **Id**：机器人呼叫任务的唯一任务ID。'."\n" + .'- **taskName**：任务名称。'."\n" + .'- **robotId**：指定机器人ID。'."\n" + .'- **robotName**：机器人名称。'."\n" + .'- **corpName**：公司名称。'."\n" + .'- **caller**：被叫显号。'."\n" + .'- **numberStatusIdent**：号码状态识别。**true**为识别，**false**为不识别。'."\n" + .'- **status**：任务状态。任务状态取值，请参见[QueryRobotTaskList](~~QueryRobotTaskList~~)中`status`取值。'."\n" + .'- **scheduleType**：调度类型。**SINGLE**为立即启动，**ORDER**为定时启动。'."\n" + .'- **retryType**：是否自动重拨。**1**为重拨，**0**为不重拨。'."\n" + .'- **recallStateCodes**：需要重拨的通话状态。**200010**为关机、**200011**为停机、**200002**为占线、**200012**为呼损、**200005**为无法接通。'."\n" + .'- **recallTimes**：重拨次数。'."\n" + .'- **recallInterval**：重拨间隔。单位：分钟。'."\n" + .'- **createTime**：任务创建时间。yyyy-MM-dd HH:mm:ss格式。'."\n" + .'- **fireTime**: 任务启动时间。yyyy-MM-dd HH:mm:ss格式。'."\n" + .'- **completeTime**: 任务完成时间。yyyy-MM-dd HH:mm:ss格式。'."\n" + .'- **filename**：被叫号码文件名。'."\n" + .'- **ossFilePath**：被叫号码文件地址。', 'type' => 'string', 'example' => '{"id":1045001,"taskName":"智能语音务","robotId":1000000075003,"robotName":"机器人","corpName":"xx公司 ","caller":"057156xxxx,0571568xxxx", "numberStatusIdent":true,"status":"INIT","scheduleType":"SINGLE", "retryType":1,"recallStateCodes":"200010,200011", "recallTimes":2,"recallInterval":5,"createTime": "2019-06-14 11:04:19","fireTime":"2019-06-14 11:05:23","completeTime": "2019-06-14 18:21:06","called": [{"fileName": "5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi", "ossFilePath": "http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx"}]}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + ], ], - [ - 'errorCode' => 'UnauthorizedOperation', - 'errorMessage' => 'You have not been authorized.', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":1045001,\\\\\\"taskName\\\\\\":\\\\\\"智能语音务\\\\\\",\\\\\\"robotId\\\\\\":1000000075003,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"corpName\\\\\\":\\\\\\"xx公司 \\\\\\",\\\\\\"caller\\\\\\":\\\\\\"057156xxxx,0571568xxxx\\\\\\", \\\\\\"numberStatusIdent\\\\\\":true,\\\\\\"status\\\\\\":\\\\\\"INIT\\\\\\",\\\\\\"scheduleType\\\\\\":\\\\\\"SINGLE\\\\\\", \\\\\\"retryType\\\\\\":1,\\\\\\"recallStateCodes\\\\\\":\\\\\\"200010,200011\\\\\\", \\\\\\"recallTimes\\\\\\":2,\\\\\\"recallInterval\\\\\\":5,\\\\\\"createTime\\\\\\": \\\\\\"2019-06-14 11:04:19\\\\\\",\\\\\\"fireTime\\\\\\":\\\\\\"2019-06-14 11:05:23\\\\\\",\\\\\\"completeTime\\\\\\": \\\\\\"2019-06-14 18:21:06\\\\\\",\\\\\\"called\\\\\\": [{\\\\\\"fileName\\\\\\": \\\\\\"5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi\\\\\\", \\\\\\"ossFilePath\\\\\\": \\\\\\"http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx\\\\\\"}]}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskDetailResponse>\\n<Data>\\n <caller>0571568xxxx,0571568xxxx</caller>\\n <createTime>2019-06-14 11:04:19</createTime>\\n <status>INIT</status>\\n <retryType>1</retryType>\\n <taskName>智能语音务</taskName>\\n <robotName>机器人</robotName>\\n <id>1045001</id>\\n <numberStatusIdent>true</numberStatusIdent>\\n <scheduleType>SINGLE</scheduleType>\\n <corpName>xx公司 </corpName>\\n <recallTimes>2</recallTimes>\\n <fireTime>2019-06-14 11:05:23</fireTime>\\n <robotId>1000000075003</robotId>\\n <called>\\n <ossFilePath>http://test.cn-hangzhou.oss.aliyun-inc.com/5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi.xlsx</ossFilePath>\\n <fileName>5102636f-7be6-4a2d-9ac7-755a2e140a50--robotCallApi</fileName>\\n </called>\\n <recallInterval>5</recallInterval>\\n <recallStateCodes>200010,200011</recallStateCodes>\\n <completeTime>2019-06-14 18:21:06</completeTime>\\n</Data>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n<Code>OK</Code>\\n</QueryRobotTaskDetailResponse>\\n","errorExample":""}]', + 'title' => '获取智能语音任务详情', + 'summary' => '获取指定智能语音任务详情。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskDetail'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + ], + 'QueryRobotTaskList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","errorExample":""},{"type":"xml","example":"<SendVerificationResponse>\\n<Message>OK</Message>\\n<RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n<Data>true</Data>\\n<Code>OK</Code>\\n</SendVerificationResponse>","errorExample":""}]', - 'title' => '发送短信验证码', - 'summary' => '发送短信验证码。', - 'description' => '### QPS限制'."\n" + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => '任务测试'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => '任务状态。取值：'."\n" + .'- **INIT**：未开始。'."\n" + .'- **READY**：准备开始。'."\n" + .'- **DISPATCH**：解析中。'."\n" + .'- **EXCUTING**：执行中。'."\n" + .'- **MANUAL_STOP**：手动暂停。'."\n" + .'- **SYSTEM_STOP**：系统暂停。'."\n" + .'- **ARREARS_STOP**：欠费暂停。'."\n" + .'- **CANCEL**：手动终止。'."\n" + .'- **SYSTEM_CANCEL**：系统终止。'."\n" + .'- **FINISH**：已完成。', 'type' => 'string', 'required' => false, 'example' => 'EXCUTING'], + ], + [ + 'name' => 'Time', + 'in' => 'query', + 'schema' => ['description' => '任务创建日期。格式：yyyy-MM-dd。', 'type' => 'string', 'required' => false, 'example' => '2019-06-14'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '智能语音任务列表。JSON格式。取值：'."\n" + .'- **id**：机器人呼叫任务的唯一任务ID。'."\n" + .'- **taskName**：任务名称。'."\n" + .'- **robotId**：指定机器人ID。'."\n" + .'- **robotName**：机器人名称。'."\n" + .'- **status**：任务状态。'."\n" + .'- **scheduleType**：调度类型。**SINGLE**为立即启动，**ORDER**为定时启动。'."\n" + .'- **createTime**：任务创建时间。yyyy.MM.dd HH:mm:ss格式。'."\n" + .'- **completeTime**：任务完成时间。yyyy.MM.dd HH:mm:ss格式。'."\n" + .'- **fireTime**：任务启动时间。yyyy.MM.dd HH:mm:ss格式。'."\n" + .'- **totalCount**：处理通话总数。'."\n" + .'- **finishCount**：完成通话个数。', 'type' => 'string', 'example' => '[ {"id": 1045001, "taskName": "智能语音任务", "robotId": 1000000075003, "robotName": "机器人", "status": "INIT","scheduleType": "SINGLE", "createTime": "2019.06.14 14:55:23", "completeTime": "2019.06.14 14:55:23", "fireTime": "2019.06.14 14:55:23", "totalCount": 1000, "finishCount": 998} ]'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'PageNo' => ['description' => '每页个数。', 'type' => 'string', 'example' => '1'], + 'Code' => ['description' => '请求状态码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'PageSize' => ['description' => '页码。', 'type' => 'string', 'example' => '1'], + 'TotalCount' => ['description' => '总任务数。', 'type' => 'string', 'example' => '1'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {\\\\\\"id\\\\\\": 1045001, \\\\\\"taskName\\\\\\": \\\\\\"智能语音任务\\\\\\", \\\\\\"robotId\\\\\\": 1000000075003, \\\\\\"robotName\\\\\\": \\\\\\"机器人\\\\\\", \\\\\\"status\\\\\\": \\\\\\"INIT\\\\\\",\\\\\\"scheduleType\\\\\\": \\\\\\"SINGLE\\\\\\", \\\\\\"createTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"completeTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"fireTime\\\\\\": \\\\\\"2019.06.14 14:55:23\\\\\\", \\\\\\"totalCount\\\\\\": 1000, \\\\\\"finishCount\\\\\\": 998} ]\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"PageNo\\": \\"1\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"PageSize\\": \\"1\\",\\n \\"TotalCount\\": \\"1\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotTaskListResponse>\\n <Data>[ {\\"id\\": 1045001, \\"taskName\\": \\"智能语音任务\\", \\"robotId\\": 1000000075003, \\"robotName\\": \\"机器人\\", \\"status\\": \\"INIT\\",\\"scheduleType\\": \\"SINGLE\\", \\"createTime\\": \\"2019.06.14 14:55:23\\", \\"completeTime\\": \\"2019.06.14 14:55:23\\", \\"fireTime\\": \\"2019.06.14 14:55:23\\", \\"totalCount\\": 1000, \\"finishCount\\": 998} ]</Data>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <PageNo>1</PageNo>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <PageSize>1</PageSize>\\n <TotalCount>1</TotalCount>\\n</QueryRobotTaskListResponse>","errorExample":""}]', + 'title' => '获取所有任务ID', + 'summary' => '获取所有语音任务信息。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], ], - 'SingleCallByVideo' => [ - 'summary' => '调用接口给单个被叫号码发送语音文件通知或视频文件通知。', - 'methods' => [ - 'post', - 'get', + 'QueryRobotv2AllList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人话术信息。JSON格式。'."\n" + .'- **id**：机器人话术ID。'."\n" + .'- **robotName**：机器人话术名称。'."\n" + .'- **robotType**：机器人话术类型。'."\n", 'type' => 'string', 'example' => '{"id":100000007****,"robotName":"机器人","robotType":"CUSTOM"}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"{\\\\\\"id\\\\\\":100000007****,\\\\\\"robotName\\\\\\":\\\\\\"机器人\\\\\\",\\\\\\"robotType\\\\\\":\\\\\\"CUSTOM\\\\\\"}\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRobotv2AllListResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>{\\"id\\":100000007****,\\"robotName\\":\\"机器人\\",\\"robotType\\":\\"CUSTOM\\"}</Data>\\n</QueryRobotv2AllListResponse>","errorExample":""}]', + 'title' => '获取全部机器人话术模板列表', + 'summary' => '获取全部机器人话术模板列表。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotv2AllList'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotv2AllList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryVideoPlayProgress' => [ + 'summary' => '在语音通话中插播视频文件后，查询视频播放进度。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '216178', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsX55VQQ', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '217974', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], ], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '发送视频通知的外呼号码（被叫显号）。'."\n" - ."\n" - .'- 如果您使用的外呼号码是公共模式，该参数不填。公共模式详情请参见[公共模式](~~172104~~)。'."\n" - .'- 如果您使用的外呼号码是专属模式，请传入您的**真实号码**或**虚拟号码**。'."\n" - .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**虚拟号管理**页面查看已创建并绑定真实号的**虚拟号**。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '0571****5678', - ], + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116004767703^102806****'], ], [ 'name' => 'CalledNumber', 'in' => 'query', + 'schema' => ['description' => '查询视频播放进度的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '接收视频通知的被叫号码。'."\n" - ."\n" - .'号码格式：'."\n" - ."\n" - .'- 手机号码。示例：159****0000。'."\n" - ."\n" - .'- 固话号码。示例：0571****5678。'."\n" - ."\n" - .'- 国际区号+号码。示例：85200****00。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1590****000', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '返回结果的提示信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回结果详情。'."\n" + ."\n" + .'- progress：当前播放时长，单位毫秒 '."\n" + ."\n" + .'- duration：文件总时长'."\n" + ."\n" + .'> 播放进度百分比可以通过progress除以duration获得。', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询视频进度', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVideoPlayProgress'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:QueryVideoPlayProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + ], + 'QueryVirtualNumberRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'VoiceCode', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => '语音通知文件的语音ID。'."\n" - ."\n" - .'您登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)在以下页面获取语音ID，该语音通知文件必须已审核通过。'."\n" - ."\n" - .'- 在**语音消息**>**语音通知**>**语音通知文件**页面获取**语音ID**。'."\n" - ."\n" - .'- 在**语音文件管理**>**语音通知文件**页面获取**语音ID**。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '17d37e58-2a09-419f-9b3d-e7e4b4****dd.wav', - ], + 'schema' => ['description' => '产品名称。默认取值：**dyvms**。', 'type' => 'string', 'required' => false, 'example' => 'dyvms', 'default' => 'dyvms'], ], [ - 'name' => 'PlayTimes', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '通知文件的播放次数。取值范围：**1~3**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => '当前页码。默认取值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'Volume', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '通知文件播放的音量。取值范围：**0~100**，默认取值**100**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '每页显示的条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '20'], ], [ - 'name' => 'Speed', + 'name' => 'RouteType', 'in' => 'query', - 'schema' => [ - 'description' => '语音文件播放的语速。取值范围：**-500~500**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '路由类型。取值：'."\n" + ."\n" + .'- **0**：归属地优先。'."\n" + ."\n" + .'- **1**：随机。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'OutId', + 'name' => 'QualificationId', 'in' => 'query', - 'schema' => [ - 'description' => '发起请求时预留给调用方的自定义ID，最终会通过回执消息将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度限制为1~15个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'abcdefgh', - ], + 'schema' => ['description' => '资质ID。此参数可不填。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000000542****'], ], [ - 'name' => 'VideoCode', + 'name' => 'RegionNameCity', 'in' => 'query', + 'schema' => ['description' => '真实号码归属地。'."\n" + ."\n" + .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)**真实号管理**页面，查询号码归属地。', 'type' => 'string', 'required' => false, 'example' => '浙江/杭州'], + ], + [ + 'name' => 'SpecId', + 'in' => 'query', + 'schema' => ['description' => '号码类型。取值：'."\n" + ."\n" + .'- **1**：虚商号码。'."\n" + .'- **2**：运营商号码。'."\n" + .'- **3**：95开头的号码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RelatedNum', + 'in' => 'query', + 'schema' => ['description' => '真实号码。'."\n" + ."\n" + .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)**真实号管理**页面，获取真实号。', 'type' => 'string', 'required' => false, 'example' => '0213144****'], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => '虚拟号码。'."\n" + ."\n" + .'您可以在[语音服务控制台](https://dyvms.console.aliyun.com/virtual/list)**服务实例管理**页面，获取服务实例ID。', 'type' => 'string', 'required' => false, 'example' => '05710000****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '视频文件', - 'description' => '视频通知文件的ID。'."\n" - ."\n" - .'您可以在[视频通知文件](https://dyvms.console.aliyun.com/videoFiles/list/notify)页面，查看已审核通过的视频通知文件ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1120213841979436_20240621103****39_.mp4', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回200代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => '服务实例和真实号绑定后的关系列表。部分字段含义：'."\n" + ."\n" + .'- **relatedNum**：真实号码。'."\n" + .'- **virtualNum**：服务实例ID。'."\n" + .'- **createTime**：号码开通时间。'."\n" + .'- **specName**：供应商名称。'."\n" + .'- **pageNo**：当前页码。'."\n" + .'- **pagSize**：每页显示的条数。'."\n" + .'- **total**：总数。'."\n" + .'- **regionNameProvince**：号码归属省。'."\n" + .'- **regionNameCity**：号码归属城市。'."\n" + .'- **corpName**：企业名称。', 'type' => 'string', 'example' => '{'."\n" + .' "data": ['."\n" + .' {'."\n" + .' "regionNameProvince": "湖南",'."\n" + .' "relatedNum": "0734284****",'."\n" + .' "specName": "联通全国",'."\n" + .' "createTime": "2021-07-02 16:04:49",'."\n" + .' "regionNameCity": "衡阳",'."\n" + .' "corpName": "阿里巴巴通信技术（北京）有限公司",'."\n" + .' "virtualNum": "05710000****"'."\n" + .' }'."\n" + .' ],'."\n" + .' "pageSize": 20,'."\n" + .' "total": 1,'."\n" + .' "pageNo": 1'."\n" + .'}'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8FAD5988-B483-48A4-B251-6E8470A67371'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], + ['errorCode' => 'VirtualNumber.NotOwn', 'errorMessage' => 'You can only use your own virtual number.', 'description' => '不能使用非自己所属的虚拟号码'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"data\\\\\\": [\\\\n {\\\\n \\\\\\"regionNameProvince\\\\\\": \\\\\\"湖南\\\\\\",\\\\n \\\\\\"relatedNum\\\\\\": \\\\\\"0734284****\\\\\\",\\\\n \\\\\\"specName\\\\\\": \\\\\\"联通全国\\\\\\",\\\\n \\\\\\"createTime\\\\\\": \\\\\\"2021-07-02 16:04:49\\\\\\",\\\\n \\\\\\"regionNameCity\\\\\\": \\\\\\"衡阳\\\\\\",\\\\n \\\\\\"corpName\\\\\\": \\\\\\"阿里巴巴通信技术（北京）有限公司\\\\\\",\\\\n \\\\\\"virtualNum\\\\\\": \\\\\\"05710000****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"pageNo\\\\\\": 1\\\\n}\\",\\n \\"RequestId\\": \\"8FAD5988-B483-48A4-B251-6E8470A67371\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryVirtualNumberRelationResponse>\\n<RequestId>8FAD5988-B483-48A4-B251-6E8470A67371</RequestId>\\n<Data>\\n <data>\\n <relatedNum>1705559****</relatedNum>\\n <createTime>2021-03-26 12:34:08</createTime>\\n </data>\\n <pageSize>20</pageSize>\\n <total>1</total>\\n <pageNo>1</pageNo>\\n</Data>\\n<Code>200</Code>\\n</QueryVirtualNumberRelationResponse>","errorExample":""}]', + 'title' => '查询服务实例与真实号码绑定关系列表', + 'summary' => '查询服务实例与真实号码绑定后的数据列表，包括绑定真实号的时间，号码创建时间，某个服务实例下绑定真实号的数量等。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：200次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVirtualNumberRelation'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'QueryVmsRealNumberCallConnectionRateInfo' => [ + 'summary' => '查询真实号接通率', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => ['title' => '虚拟号码', 'description' => '虚拟号码', 'type' => 'string', 'required' => false, 'example' => '0571***1234'], + ], + [ + 'name' => 'RealNumber', + 'in' => 'query', + 'schema' => ['title' => '真实号码', 'description' => '真实号码', 'type' => 'string', 'required' => false, 'example' => '131***1234'], + ], + [ + 'name' => 'TimePeriod', + 'in' => 'query', + 'schema' => ['title' => '时间段', 'description' => '时间段（起始毫秒时间戳-结束毫秒时间戳）', 'type' => 'string', 'required' => false, 'example' => '1764666240123-1764686240567'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'CallId' => [ - 'description' => '语音通知或视频通知的唯一ID。'."\n" - ."\n" - .'您可以使用此参数，调用[PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm)接口播放视频等操作。'."\n" - .'您可以[配置回执消息](https://help.aliyun.com/zh/vms/developer-reference/return-receipt-message-description-and-configuration-process?spm)，获取呼叫记录消息、呼叫中间状态消息、录音记录消息等。', - 'type' => 'string', - 'example' => '116012354148^10281378****', + 'AccessDeniedDetail' => ['description' => '本组参数已弃用，请忽略。', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['title' => '', 'description' => '请求ID', 'type' => 'string', 'example' => '95B86652-B234-5387-BAC6-E441FR49399F'], + 'Message' => ['title' => '', 'description' => '返回结果的提示信息。', 'type' => 'string', 'example' => '参数缺失！'], + 'Model' => [ + 'title' => '', + 'description' => '请求结果数据', + 'type' => 'object', + 'properties' => [ + 'RingingRate' => ['title' => '响铃率', 'description' => '响铃率', 'type' => 'number', 'format' => 'double', 'example' => '25.4222'], + 'ResourceId' => ['title' => '', 'description' => '弃用参数，请忽略', 'type' => 'string', 'example' => '无'], + 'RingingCount' => ['title' => '响铃数', 'description' => '响铃数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'ResourceType' => ['title' => 'EcsInstance, EcsDisk, EcsImage, EcsSnapshot, EcsSecurityGroup, EcsEip, EcsVpc, EcsVRouter, EcsVSwitch, EcsVRouteTable, EcsAuthImage, EcsAll, SlbLoadbalancer, SlbVm, RdsInstance, RdsAllInstance, KvsInstance, OcsInstance, OdpsInstance', 'description' => '弃用参数，请忽略', 'type' => 'string', 'example' => '无'], + 'RegionId' => ['title' => '', 'description' => '弃用参数，请忽略', 'type' => 'string', 'example' => '无'], + 'CallConnectionRate' => ['title' => '接通率', 'description' => '接通率', 'type' => 'number', 'format' => 'double', 'example' => '6.71672'], + 'RequestCount' => ['title' => '请求通话数', 'description' => '请求通话数', 'type' => 'integer', 'format' => 'int64', 'example' => '49'], + 'CompleteCount' => ['title' => '接通数', 'description' => '接通数', 'type' => 'integer', 'format' => 'int64', 'example' => '52'], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => '请求是否成功。'."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"95B86652-B234-5387-BAC6-E441FR49399F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"RingingRate\\": 25.4222,\\n \\"ResourceId\\": \\"无\\",\\n \\"RingingCount\\": 3,\\n \\"ResourceType\\": \\"无\\",\\n \\"RegionId\\": \\"无\\",\\n \\"CallConnectionRate\\": 6.71672,\\n \\"RequestCount\\": 49,\\n \\"CompleteCount\\": 52\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询真实号接通率', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', - 'title' => '发送视频通知', - 'description' => '- 目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。'."\n" - ."\n" - .'- 调用此接口发送视频通知后，还可以在通话中调用[PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm)接口播放视频、[PauseVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-pausevideofile?spm)接口暂停视频、[ResumeVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-resumevideofile?spm)接口恢复视频。', + 'ramActions' => [], ], - 'PlayVideoFile' => [ - 'summary' => '在语音通话中插播视频文件。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryVmsVirtualNumberRelationByPage' => [ + 'summary' => '查询虚拟号码与真实号码绑定关系列表', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6050,73 +11807,46 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '201522', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'VideoId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '视频插播文件ID。'."\n" - ."\n" - .'您可以在[视频插播文件](https://dyvms.console.aliyun.com/videoFiles/list/slot)页面查看审核通过的视频ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1120213841979436_20240620155*****5_.mp4', - ], + 'schema' => ['title' => '', 'description' => '每页返回的结果个数。 取值范围：1~100。 默认值：20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '81'], ], [ - 'name' => 'CalledNumber', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '接收视频播放的手机号码。', - 'type' => 'string', - 'required' => false, - 'example' => '159****0000', - ], + 'schema' => ['title' => '', 'description' => '页码。默认取值为**1**。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '74'], ], [ - 'name' => 'CallId', + 'name' => 'VirtualNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话一ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。'."\n" - ."\n" - .'> 您可以使用CallId，调用[QueryVideoPlayProgress](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-queryvideoplayprogress?spm)接口查看视频播放进度。', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^1028137841****', - ], + 'schema' => ['title' => '虚拟号码', 'description' => '虚拟号码', 'type' => 'string', 'required' => false, 'example' => '0571****1234'], ], [ - 'name' => 'OutId', + 'name' => 'RealNumber', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度限制为1~15个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '342268*****', - ], + 'schema' => ['title' => '真实号码', 'description' => '真实号码', 'type' => 'string', 'required' => false, 'example' => '131***1234'], ], [ - 'name' => 'OnlyPhone', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => '仅在手机端播放视频。取值：'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false（默认值）', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '状态 1:有效；0:无效；-1:注销', 'description' => '状态。可选值：'."\n" + ."\n" + .'- 1：有效'."\n" + .'- 0：无效'."\n" + .'- -1：注销', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'NumberCity', + 'in' => 'query', + 'schema' => ['title' => '号码归属地--城市', 'description' => '号码归属地--城市', 'type' => 'string', 'required' => false, 'example' => '北京'], + ], + [ + 'name' => 'NumberProvince', + 'in' => 'query', + 'schema' => ['title' => '号码归属地--省', 'description' => '号码归属地--省', 'type' => 'string', 'required' => false, 'example' => '北京'], ], ], 'responses' => [ @@ -6124,146 +11854,245 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], + 'AccessDeniedDetail' => ['description' => '已失效参数，请忽略', 'type' => 'string', 'example' => '无'], + 'RequestId' => ['title' => '', 'description' => '请求ID', 'type' => 'string', 'example' => '01A58FA5-422C-58E0-AA71-B307A665416F'], + 'Message' => ['title' => '', 'description' => '返回结果的提示信息。', 'type' => 'string', 'example' => '参数缺失！'], 'Model' => [ - 'description' => '通话类型。'."\n" - ."\n" - .'- video'."\n" - ."\n" - .'- voice', - 'type' => 'boolean', - 'example' => 'video', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回**OK**代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['title' => '', 'description' => '每页显示的条数', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], + 'Total' => ['title' => '', 'description' => '总条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '231'], + 'PageNo' => ['title' => '', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Data' => [ + 'title' => '', + 'description' => '返回对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'RealNumber' => ['title' => '真实号码', 'description' => '真实号码', 'type' => 'string', 'example' => '131****1234'], + 'VirtualNumber' => ['title' => '虚拟号码', 'description' => '虚拟号码', 'type' => 'string', 'example' => '0571***1234'], + 'State' => ['title' => '状态 1:有效；0:无效；-1:注销', 'description' => '状态。可选址：'."\n" + .'- 1：有效；'."\n" + .'- 0：无效；'."\n" + .'- -1：注销。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'NumberCity' => ['title' => '号码归属地--城市', 'description' => '号码归属地--城市', 'type' => 'string', 'example' => '北京'], + 'NumberProvince' => ['title' => '号码归属地--省', 'description' => '号码归属地--省', 'type' => 'string', 'example' => '北京'], + ], + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['title' => '', 'description' => '接口调用是否成功。'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '插播视频', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'PauseVideoFile' => [ - 'summary' => '在语音通话中插播视频文件时，暂停视频播放。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"01A58FA5-422C-58E0-AA71-B307A665416F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"PageSize\\": 65,\\n \\"Total\\": 231,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"RealNumber\\": \\"131****1234\\",\\n \\"VirtualNumber\\": \\"0571***1234\\",\\n \\"State\\": 1,\\n \\"NumberCity\\": \\"北京\\",\\n \\"NumberProvince\\": \\"北京\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询虚拟号码与真实号码绑定关系列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], ], + 'ramActions' => [], + ], + 'QueryVoiceFileAuditInfo' => [ + 'summary' => '查询语音文件审核状态。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '201533', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '120076', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'VoiceCodes', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => '语音文件ID。'."\n" + ."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音文件管理**页面查看**语音ID**。'."\n" + ."\n" + .'> 每次查询最多支持10个语音文件，以半角逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => '8501d2eb-efbb-471f-xxx8-****.wav'], ], [ - 'name' => 'CalledNumber', + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => '暂停视频播放的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', + 'description' => '语音文件类型。取值：'."\n" + ."\n" + .'- **0**（默认值）：语音通知文件'."\n" + .'- **2**：通话放音文件', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'default' => '0', + 'enum' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回参数。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'返回OK代表请求成功。'."\n" + .'其他状态码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], 'Data' => [ - 'description' => '返回结果详情。', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '本次请求是否成功调用成功。取值：'."\n" - .'- **true**：调用成功。'."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'VoiceCode' => ['description' => '语音文件Code。', 'type' => 'string', 'example' => '8501d2eb-efbb-471f-xxx8-****.wav'], + 'AuditState' => ['description' => '审核状态。取值：'."\n" + ."\n" + .'- **AUDIT_STATE_INIT**：审批中'."\n" + .'- **AUDIT_STATE_PASS**：审批通过'."\n" + .'- **AUDIT_STATE_NOT_PASS**：审批不通过'."\n" + .'- **AUDIT_STATE_UPLOADING**：审批已通过文件上传中'."\n" + .'- **AUDIT_STATE_REDOING**：重新处理中'."\n" + .'- **AUDIT_SATE_CANCEL**：取消审批'."\n" + .'- **AUDIT_PAUSE**：暂停审批'."\n" + .'- **AUDIT_ORDER_FINISHED**：工单系统审核完成，等待运营商审核', 'type' => 'string', 'example' => 'AUDIT_STATE_NOT_PASS'], + 'RejectInfo' => ['description' => '审核信息。', 'type' => 'string', 'example' => '如电话沟通，该业务暂不支持'], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Query.Voice.File.Limit', 'errorMessage' => 'Voice file query number cannot exceed 10', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"VoiceCode\\": \\"8501d2eb-efbb-471f-xxx8-****.wav\\",\\n \\"AuditState\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"RejectInfo\\": \\"如电话沟通，该业务暂不支持\\"\\n }\\n ],\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Message\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询语音文件审核状态', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceFileAuditInfo'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVoiceFileAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '暂停视频', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', ], - 'ResumeVideoFile' => [ - 'summary' => '在语音通话中暂停视频播放后，恢复视频播放。', - 'methods' => [ - 'post', - 'get', + 'RecoverCallInConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Number', + 'in' => 'query', + 'schema' => ['description' => '需要恢复呼入的400号码。', 'type' => 'string', 'required' => true, 'example' => '400***'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainApiResponse<Boolean>', + 'description' => 'PlainApiResponse<Boolean>', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => '恢复是否成功。取值：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => '成功'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => '无效参数'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', + 'title' => '400呼转号码恢复呼入', + 'summary' => '调用RecoverCallInConfig恢复指定400呼转号码呼入。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecoverCallInConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:RecoverCallInConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ResumeVideoFile' => [ + 'summary' => '在语音通话中暂停视频播放后，恢复视频播放。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6274,30 +12103,18 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '201535', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], ], 'parameters' => [ [ 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '100001616500^1000018****', - ], + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '100001616500^1000018****'], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '恢复视频播放的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => '恢复视频播放的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], ], ], 'responses' => [ @@ -6305,430 +12122,459 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误提示信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回数据详情。', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[错误码列表](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - ."\n" - .'- true：调用成功。'."\n" - ."\n" - .'- false：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误提示信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回数据详情。', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => '恢复视频', 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'QueryVideoPlayProgress' => [ - 'summary' => '在语音通话中插播视频文件后，查询视频播放进度。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:ResumeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SendVerification' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217974', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52709', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'VerifyType', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116004767703^102806****', - ], + 'schema' => ['description' => '短信验证码发送类型。固定取值：**SMS**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS'], ], [ - 'name' => 'CalledNumber', + 'name' => 'BizType', 'in' => 'query', - 'schema' => [ - 'description' => '查询视频播放进度的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => '业务类型。固定取值：**CONTACT**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CONTACT'], + ], + [ + 'name' => 'Target', + 'in' => 'query', + 'schema' => ['description' => '接收短信验证码的手机号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '150****0000'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '返回结果的提示信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回结果详情。'."\n" - ."\n" - .'- progress：当前播放时长，单位毫秒 '."\n" - ."\n" - .'- duration：文件总时长'."\n" - ."\n" - .'> 播放进度百分比可以通过progress除以duration获得。', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - ."\n" - .'- true：调用成功。'."\n" - ."\n" - .'- false：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '验证码是否发送成功。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '查询视频进度', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'UpgradeVideoFile' => [ - 'summary' => '从语音通话升级到视频通话。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Mobile.Invalid', 'errorMessage' => 'The mobile number is invalid.', 'description' => ''], + ['errorCode' => 'UnauthorizedOperation', 'errorMessage' => 'You have not been authorized.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","errorExample":""},{"type":"xml","example":"<SendVerificationResponse>\\n<Message>OK</Message>\\n<RequestId>6086693B-2250-17CE-A41F-06259AB6DB1B</RequestId>\\n<Data>true</Data>\\n<Code>OK</Code>\\n</SendVerificationResponse>","errorExample":""}]', + 'title' => '发送短信验证码', + 'summary' => '发送短信验证码。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendVerification'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SendVerification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SetTransferCalleePoolConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217976', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'Details', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^10281378****', + 'description' => '呼转号码信息。', + 'type' => 'array', + 'items' => [ + 'description' => '呼转号码信息。', + 'type' => 'object', + 'properties' => [ + 'Caller' => ['description' => '主叫号码。', 'type' => 'string', 'required' => false, 'example' => '150****0000'], + 'Called' => ['description' => '被叫号码。已备案的号码。'."\n" + ."\n" + .'您可以通过[SubmitHotlineTransferRegister](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-submithotlinetransferregister?spm=a2c4g.11186623.0.0.7b784120BH0XPT)接口，提交号码备案。', 'type' => 'string', 'required' => true, 'example' => '151****0000'], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, ], ], [ - 'name' => 'MediaType', + 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型。固定取值：**video**。', - 'type' => 'string', - 'required' => false, - 'example' => 'video', - 'default' => 'VIDEO', - ], + 'schema' => ['description' => '呼转号码。'."\n" + ."\n" + .'您已在[语音服务控制台真实号码管理页面](https://dyvms.console.aliyun.com/number/list/400)购买的400号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400903****'], ], [ - 'name' => 'OutId', + 'name' => 'QualificationId', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度限制为1~15个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '190***'], ], [ - 'name' => 'CalledNumber', + 'name' => 'CalledRouteMode', 'in' => 'query', - 'schema' => [ - 'description' => '接收视频通话的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => '呼叫模式。取值：'."\n" + ."\n" + .'- **roundRobin**：轮询。'."\n" + .'- **random**：随机。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'roundRobin'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回的数据内容。', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - ."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。'."\n", 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '转呼号码配置详情。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7518CE1-B0FF-4C6F-9252-BF80271B2F99'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '视频升级', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'DegradeVideoFile' => [ - 'summary' => '从视频通话降级到语音通话。', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E7518CE1-B0FF-4C6F-9252-BF80271B2F99\\"\\n}","type":"json"}]', + 'title' => '设置400号码呼转', + 'summary' => '为400号码设置转呼号码。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTransferCalleePoolConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SetTransferCalleePoolConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SingleCallByTts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '217975', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52711', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], ], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116012354148^1028137841****', - ], + 'schema' => ['description' => '发送语音通知或语音验证码的通话号码（被叫显号）。若此参数不填，则为公共模式通话；若传入真实号或服务实例ID，则为专属模式通话。**参数`TtsCode`传入的模板ID的外呼模式必须与此处外呼模式匹配**。'."\n" + ."\n" + .'- 如果您使用公共模式，该参数不填，将由系统随机调度使用公共号码池内的号码通话。公共模式与专属模式区别请参见[公共模式/专属模式](~~172104~~)。'."\n" + .'- 如果您使用专属模式，请传入您的**真实号码**或**服务实例ID**。'."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**服务实例管理**页面查看已创建并绑定真实号的**服务实例**。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678'], ], [ - 'name' => 'MediaType', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '媒体类型。固定取值：video。', - 'type' => 'string', - 'required' => false, - 'example' => 'video', - 'default' => 'AUDIO', - ], + 'schema' => ['description' => '接收语音通知或语音验证码的被叫号码。'."\n" + ."\n" + .'号码格式：'."\n" + .'- 手机号码。示例：159****0000。'."\n" + .'- 固话号码。示例：0571****5678。'."\n" + .'> - 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n" + .'> - 同一个**资质信息+号码用途**，拨打每一个被叫号码的频次有流控限制：1次/分钟、5次/小时、20次/24小时。 流控规则计时从第一次正常外呼开始，超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。'."\n" + .'> - 如**使用专属模式**调用此接口且您的业务需要更宽松的流控频率，您可至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)--通用设置--呼叫设置--呼出流控-频次中，尝试**申请调整流控次数**，**公共模式不支持**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****000'], ], [ - 'name' => 'OutId', + 'name' => 'TtsCode', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度为1~15个字节。', - 'type' => 'string', - 'required' => false, - 'example' => '225869*****', - ], + 'schema' => ['description' => '文本转语音模板或语音验证码模板的模板ID。'."\n" + .'您可登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在以下页面获取已通过审核的语音模板ID。'."\n" + .'- 在**语音消息**>**语音验证码**获取**模板ID**。'."\n" + .'- 在**语音消息**>**语音通知**页面获取**模板ID**。'."\n" + ."\n\n" + .'><notice>'."\n" + ."\n" + .'- 在控制台选择模板ID时请注意**外呼号码**字段是否与参数`CalledShowNumber`的外呼模式匹配。'."\n" + .'- 语音模板归属账号和调用该接口的账号需保持一致。'."\n" + .'</notice>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TTS_28726****'], ], [ - 'name' => 'CalledNumber', + 'name' => 'TtsParam', 'in' => 'query', - 'schema' => [ - 'description' => '接收语音通知的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['description' => '语音模板中的变量参数，JSON格式。'."\n" + .'变量规范详情，请参见[模板规范](https://help.aliyun.com/zh/vms/user-guide/voice-template-specification?spm=a2c4g.11186623.0.0.6ebf68529bX2fG)。', 'type' => 'string', 'required' => false, 'example' => '{"AckNum":"123456"}'], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => '语音文件或语音验证的播放次数。取值范围：**1~3**，默认取值**3**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => '语音通话的音量。取值范围：**0~100**，默认取值**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => '语音通话的语速。取值范围为：**-500~500**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '发起请求时预留给调用方的自定义ID，最终会通过回执消息将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度限制为1~15个字符。', 'type' => 'string', 'required' => false, 'example' => '225869*****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误提示信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回的数据内容。', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码详见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'CallId' => ['description' => '此次通话的唯一回执ID。'."\n" + ."\n" + .'可以使用此CallId，调用[QueryCallDetailByCallId](~~393529~~)接口查询呼叫详情。', 'type' => 'string', 'example' => '116012354148^10281378****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '视频降级', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'SkipVideoFile' => [ - 'summary' => '在播放视频时，可以调用此接口快进视频或后退视频。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => '发送语音验证码或文本转语音类型的语音通知', + 'summary' => '调用接口给单个被叫号码发送语音验证码或文本转语音类型的语音通知。', + 'description' => '- 请在使用该接口前，了解语音服务套餐包及功能计费，详情请参见[国内语音服务定价](~~150083~~)。'."\n" + ."\n" + .'- 文本转语音模板公共模式和专属模式不通用，如果您使用公共模式调用本接口，请申请并使用**公共模式**的语音模板发起通话，专属模式同理。'."\n" + ."\n" + .'- 如果需要批量发送语音任务，请使用[CreateCallTask](~~393512~~)接口创建语音任务（创建语音任务仅限专属模式且需使用服务实例调用）。'."\n" + ."\n" + .'- 本接口支持发送语音验证码或文本转语音类型的语音通知，如您需要发送语音通知文件类型的语音通知，请至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)上传语音文件后使用[SingleCallByVoice](~~393517~~)接口。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：1000次/秒。', + 'requestParamsDescription' => '请在调用前确认您传入的模板ID外呼模式类型是否与参数`CalledShowNumber`匹配，不匹配时无法调用成功：'."\n" + ."\n" + .'- 若`CalledShowNumber`不填：即为**公共模式**，参数`TtsCode`应**传入外呼号码为公共模式外呼**的模板ID。'."\n" + .'- 若`CalledShowNumber`填入自行申请的真实号或服务实例ID：即为**专属模式**，参数`TtsCode`应**传入外呼号码为专属模式外呼**的模板ID。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByTts'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SingleCallByVideo' => [ + 'summary' => '调用接口给单个被叫号码发送语音文件通知或视频文件通知。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '218113', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsL1CC4Y', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '216178', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], ], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => '发送视频通知的外呼号码（被叫显号）。'."\n" + ."\n" + .'- 如果您使用的外呼号码是公共模式，该参数不填。公共模式详情请参见[公共模式](~~172104~~)。'."\n" + .'- 如果您使用的外呼号码是专属模式，请传入您的**真实号码**或**虚拟号码**。'."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**虚拟号管理**页面查看已创建并绑定真实号的**虚拟号**。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678'], ], [ - 'name' => 'SkipTimes', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '跳转到对应的时间播放视频，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '04:02:01', - ], + 'schema' => ['description' => '接收视频通知的被叫号码。'."\n" + ."\n" + .'号码格式：'."\n" + ."\n" + .'- 手机号码。示例：159****0000。'."\n" + ."\n" + .'- 固话号码。示例：0571****5678。'."\n" + ."\n" + .'- 国际区号+号码。示例：85200****00。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****000'], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => '语音通知文件的语音ID。'."\n" + ."\n" + .'您登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)在以下页面获取语音ID，该语音通知文件必须已审核通过。'."\n" + ."\n" + .'- 在**语音消息**>**语音通知**>**语音通知文件**页面获取**语音ID**。'."\n" + ."\n" + .'- 在**语音文件管理**>**语音通知文件**页面获取**语音ID**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '17d37e58-2a09-419f-9b3d-e7e4b4****dd.wav'], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => '通知文件的播放次数。取值范围：**1~3**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => '通知文件播放的音量。取值范围：**0~100**，默认取值**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => '语音文件播放的语速。取值范围：**-500~500**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" - ."\n" - .'字符串类型，长度为1~15个字节。', - 'type' => 'string', - 'required' => false, - 'example' => 'PR0210428****', - ], + 'schema' => ['description' => '发起请求时预留给调用方的自定义ID，最终会通过回执消息将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度限制为1~15个字符。', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh'], ], [ - 'name' => 'CalledNumber', + 'name' => 'VideoCode', 'in' => 'query', - 'schema' => [ - 'description' => '接收视频播放的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '159****0000', - ], + 'schema' => ['title' => '视频文件', 'description' => '视频通知文件的ID。'."\n" + ."\n" + .'您可以在[视频通知文件](https://dyvms.console.aliyun.com/videoFiles/list/notify)页面，查看已审核通过的视频通知文件ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1120213841979436_20240621103****39_.mp4'], ], ], 'responses' => [ @@ -6736,150 +12582,179 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => '返回的数据内容。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***'], + 'CallId' => ['description' => '语音通知或视频通知的唯一ID。'."\n" + ."\n" + .'您可以使用此参数，调用[PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm)接口播放视频等操作。'."\n" + .'您可以[配置回执消息](https://help.aliyun.com/zh/vms/developer-reference/return-receipt-message-description-and-configuration-process?spm)，获取呼叫记录消息、呼叫中间状态消息、录音记录消息等。', 'type' => 'string', 'example' => '116012354148^10281378****'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '快进或后退视频', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', - ], - 'GetCallMediaType' => [ - 'summary' => '在通话时获取通话类型。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"CallId\\": \\"116012354148^10281378****\\"\\n}","type":"json"}]', + 'title' => '发送视频通知', + 'description' => '- 目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。'."\n" + ."\n" + .'- 调用此接口发送视频通知后，还可以在通话中调用[PlayVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-playvideofile?spm)接口播放视频、[PauseVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-pausevideofile?spm)接口暂停视频、[ResumeVideoFile](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-resumevideofile?spm)接口恢复视频。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVideo'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SingleCallByVoice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52712', + 'abilityTreeNodes' => ['FEATUREdyvmsX55VQQ'], ], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', - 'type' => 'string', - 'required' => false, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => '发送语音通知的通话号码（被叫显号）。若此参数不填，则为公共模式通话；若传入真实号或服务实例ID，则为专属模式通话。'."\n" + ."\n" + .'- 如果您使用公共模式通话，该参数不填。将由系统随机调度使用公共号码池内的号码通话。'."\n" + .'- 如果您使用专属模式通话，请传入您的**真实号码**或**服务实例ID**。'."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/number/list/normal)，在**真实号管理**页面查看已购买的**真实号**，在**服务实例管理**页面查看已创建并绑定真实号的**服务实例**。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0571****5678'], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '通话中的手机号码。', - 'type' => 'string', - 'required' => true, - 'example' => '1580000****', - ], + 'schema' => ['description' => '接收语音通知的被叫号码。'."\n" + ."\n" + .'号码格式：'."\n" + .'- 手机号码。示例：159****0000。'."\n" + .'- 固话号码。示例：0571****5678。'."\n" + .'> - 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码，可以多次调用。'."\n" + .'> - 同一个**资质信息+号码用途**，拨打每一个被叫号码的频次有流控限制：1次/分钟、5次/小时、20次/24小时。 流控规则计时从第一次正常外呼开始，超过这个频率就会触发流控。呼叫成功或失败都会消耗一次流控频率。'."\n" + .'> - 如**使用专属模式**调用此接口且您的业务需要更宽松的流控频率，您可至[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)--通用设置--呼叫设置--呼出流控-频次中，尝试**申请调整流控次数**，**公共模式不支持**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '159****0000'], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => '语音通知文件的语音ID。传入的语音ID的外呼模式类型应与CalledShowNumber匹配。'."\n" + ."\n" + .'您可登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)在以下页面获取语音ID，该语音通知文件必须已审核通过。'."\n" + ."\n" + .'- 在**语音消息**>**语音通知**>**语音通知文件**页面获取**语音ID**。'."\n" + ."\n" + .'- 在**语音文件管理**>**语音通知文件**页面获取**语音ID**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav'], + ], + [ + 'name' => 'PlayTimes', + 'in' => 'query', + 'schema' => ['description' => '语音通知文件的播放次数。取值范围：**1~3**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => '语音通知文件播放的音量。取值范围：**0~100**，默认取值**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => '语音文件播放的语速。取值范围：**-500~500**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度限制为1~15个字符。', 'type' => 'string', 'required' => false, 'example' => '22596****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Data' => [ - 'description' => 'MediaType：媒体类型。'."\n" - ."\n" - .'- audio'."\n" - .'- video'."\n" - .'- Null（切换中不确定）', - 'type' => 'object', - 'example' => 'video', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '请求是否成功。'."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回**OK**代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E50FFA85-0B79-4421-A7BD-00B0A271966F'], + 'CallId' => ['description' => '此次通话的唯一回执ID。'."\n" + ."\n" + .'可以使用此CallId，调用[QueryCallDetailByCallId](~~393529~~)接口查询指定通话详情。', 'type' => 'string', 'example' => '116004767703^102806****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E50FFA85-0B79-4421-A7BD-00B0A271966F\\",\\n \\"CallId\\": \\"116004767703^102806****\\"\\n}","type":"json"}]', + 'title' => '发送语音通知文件类型的语音通知', + 'summary' => '调用接口给单个被叫号码发送语音通知文件类型的语音通知。', + 'description' => '- 请在使用该接口前，了解语音服务套餐包及功能计费，详情请参见[国内语音服务定价](~~150083~~)。'."\n" + ."\n" + .'- 语音文件公共模式和专属模式不通用，如果您使用公共模式调用本接口，请在**导入语音文件时外呼号码选择公共模式外呼**，专属模式同理。'."\n" + ."\n" + .'- 语音通知文件不支持变量参数，如您需要发送带变量的语音通知，请至[语音服务控制台](https://dyvms.console.aliyun.com/call/notify/addt2v)申请**文本转语音模板**后使用[SingleCallByTts](~~393519~~)接口。'."\n" + ."\n" + .'- 如果需要批量发送语音任务，请使用[CreateCallTask](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-createcalltask?spm=a2c4g.11186623.0.0.12771c4esA3Fbv)接口创建语音任务（创建语音任务仅限专属模式且需使用服务实例调用）。'."\n" + ."\n\n" + .'### QPS限制'."\n" + .'单用户调用频率：1200次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVoice'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '获取通话类型', - 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', ], - 'GetTemporaryFileUrl' => [ - 'summary' => '获取视频或语音文件临时URL，方便您立即查看视频或语音文件。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SkipVideoFile' => [ + 'summary' => '在播放视频时，可以调用此接口快进视频或后退视频。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6888,24 +12763,32 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'update', + 'abilityTreeCode' => '218113', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], ], 'parameters' => [ [ - 'name' => 'VideoId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '音频或视频ID。'."\n" - ."\n" - .'您可以在语音服务控制台[语音文件管理](https://dyvms.console.aliyun.com/files/list/voiceFiles)页面或[视频文件管理](https://dyvms.console.aliyun.com/videoFiles/list/slot)页面，查看语音ID或视频ID。', - 'type' => 'string', - 'required' => true, - 'example' => '45a04670582571eebf9e4531948c****', - ], + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116012854210^10281427****'], + ], + [ + 'name' => 'SkipTimes', + 'in' => 'query', + 'schema' => ['description' => '跳转到对应的时间播放视频，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '04:02:01'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => 'PR0210428****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '接收视频播放的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], ], ], 'responses' => [ @@ -6913,88 +12796,253 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息。', - 'type' => 'string', - 'example' => '无', - ], - 'Message' => [ - 'description' => '错误信息。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7BF47617-7851-48F7-A3A1-2021342A****', - ], - 'Data' => [ - 'description' => '- private String videoFileUrl：播放文件URL'."\n" - .'- private String videoFile：语音或视频文件'."\n" - .'- private Long fileExpireTime：文件过期时间，单位毫秒', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - ."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '接口调用是否成功。'."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回的数据内容。', 'type' => 'boolean', 'example' => 'false'], + 'Code' => ['description' => '请求状态码。'."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '快进或后退视频', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SkipVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BF47617-7851-48F7-A3A1-2021342A****\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '获取文件临时URL', ], - 'GetToken' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '52685', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52713', + 'abilityTreeNodes' => ['FEATUREdyvms59DC26'], ], 'parameters' => [ [ - 'name' => 'TokenType', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'Token类型。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'dyvms', - 'minLength' => 0, - ], + 'schema' => ['description' => '被叫显号。必须是已购买的号码。'."\n" + ."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，在**语音号码**>**真实号管理**页面查看已购买的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0571****5678'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。仅支持中国内地号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1590****0000'], + ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => '智能外呼放音文件。'."\n" + ."\n" + .'当放音文件为控制台上传的语音文件时：参数**VoiceCode**指定为文件的语音ID。您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**语音文件管理**>**智能语音交互放音文件**，单击**详情**查看对应的**语音ID**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$'], + ], + [ + 'name' => 'RecordFlag', + 'in' => 'query', + 'schema' => ['description' => '通话过程中是否录音。取值：'."\n" + ."\n" + .'- **true**：录音。'."\n" + .'- **false**：不录音。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Volume', + 'in' => 'query', + 'schema' => ['description' => '播放用户音频的音量。取值范围：**-4~4**，建议设置为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Speed', + 'in' => 'query', + 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AsrModelId', + 'in' => 'query', + 'schema' => ['description' => 'ASR模型。取值：'."\n" + ."\n" + .'- **customer_service_8k**（默认）：普通话。'."\n" + .'- **dialect_customer_service_8k**：重口音。'."\n" + ."\n" + .'> 调用SmartCall接口时需要指定使用的ASR模型，建议参数AsrModelId和AsrBaseId二者选填其一。'."\n" + .'> - 如果仅设置AsrModelId，表示使用指定的ASR模型。'."\n" + .'> - 如果仅设置AsrBaseId，表示使用指定的ASR基础模型。'."\n" + .'> - 如果二者均未设置，则使用默认的ASR基础模型，即参数AsrBaseId默认为customer_service_8k，表示使用ASR普通话基础模型。'."\n" + .'> - 如果二者同时设置，请确认二者是正确对应的。', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k'], + ], + [ + 'name' => 'PauseTime', + 'in' => 'query', + 'schema' => ['description' => '停顿时长。用于设置用户停顿多久表示一句话结束。单位：毫秒，取值范围：**300~1200**。'."\n" + ."\n" + .'> - 如果指定值不在参数范围中，则该参数默认取值为**800**。'."\n" + .'> - 该参数首次设置有效，后续设置无效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'], + ], + [ + 'name' => 'MuteTime', + 'in' => 'query', + 'schema' => ['description' => '静音时长。用于设置用户多久不说话通话结束。单位：毫秒，取值范围：**1000~20000**。'."\n" + ."\n" + .'> - 如果指定值不在参数范围中，则该参数默认取值为**10000**。'."\n" + .'> - 通话过程中可动态设置，以最后一次设置为准。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'ActionCodeBreak', + 'in' => 'query', + 'schema' => ['description' => '当前返回的媒体文件是否可以被打断。默认取值为**true**，即可被打断。'."\n" + ."\n" + .'如果为false，即使下一个动作action_break为true，也无法打断当前放音。'."\n" + ."\n" + .'> action_code_break优先级高于action_break。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方使用的ID。 最终会通过在回执消息中将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度为1~15个字节。', 'type' => 'string', 'required' => false, 'example' => '342268*****'], + ], + [ + 'name' => 'DynamicId', + 'in' => 'query', + 'schema' => ['description' => '预留给调用方使用的动态扩展ID。在回调地址中带回，用于客户的开发标识。', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh'], + ], + [ + 'name' => 'EarlyMediaAsr', + 'in' => 'query', + 'schema' => ['description' => '早媒体语音识别标识。取值：'."\n" + ."\n" + .'- **false**（默认）：关闭。'."\n" + .'- **true**：开启。'."\n" + ."\n" + .'> 设为**true**会记录通话未接听的原因。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'VoiceCodeParam', + 'in' => 'query', + 'schema' => ['description' => 'TTS参数传递字符串，格式为JSON。必须与**VoiceCode**的TTS参数对应。'."\n", 'type' => 'string', 'required' => false, 'example' => '{"name":"喂,你好"}'], + ], + [ + 'name' => 'SessionTimeout', + 'in' => 'query', + 'schema' => ['description' => '最大通话时长，超时后自动挂断。单位：秒。'."\n" + ."\n" + .'> 通话时长最长3600秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'], + ], + [ + 'name' => 'ActionCodeTimeBreak', + 'in' => 'query', + 'schema' => ['description' => '基于用户持续说话时长打断。单位：毫秒。'."\n" + ."\n" + .'如果当前媒体文件ActionCodeBreak为**true**，用户持续说话可以打断当前播放。不设置或者为0，不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'], + ], + [ + 'name' => 'TtsStyle', + 'in' => 'query', + 'schema' => ['description' => 'TTS变量播放时的声音风格。默认为**xiaoyun**。具体风格，请参见下表**声音风格列表**。', 'type' => 'string', 'required' => false, 'example' => 'xiaoyun'], + ], + [ + 'name' => 'TtsVolume', + 'in' => 'query', + 'schema' => ['description' => 'TTS变量播放的音量。取值范围：**0~100**，默认值为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'TtsSpeed', + 'in' => 'query', + 'schema' => ['description' => 'TTS变量播放时的声音速度。取值范围：**-200~200**，默认值为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'TtsConf', + 'in' => 'query', + 'schema' => ['description' => '是否设置TTS声音参数。取值：'."\n" + ."\n" + .'- **true**：设置。需要通过**TtsStyle**、**TtsVolume**、**TtsSpeed**三个参数来设置声音风格。'."\n" + .'- **false**：不设置。不需要设置相关参数，即便设置了也不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsrBaseId', + 'in' => 'query', + 'schema' => ['description' => 'ASR基础模型。取值：'."\n" + ."\n" + .'- **customer_service_8k**（默认）：普通话。'."\n" + .'- **dialect_customer_service_8k**：重口音。'."\n" + ."\n" + .'> 调用SmartCall接口时需要指定使用的ASR模型，建议参数AsrModelId和AsrBaseId二者选填其一。'."\n" + .'> - 如果仅设置AsrModelId，表示使用指定的ASR模型。'."\n" + .'> - 如果仅设置AsrBaseId，表示使用指定的ASR基础模型。'."\n" + .'> - 如果二者均未设置，则使用默认的ASR基础模型，即参数AsrBaseId默认为customer_service_8k，表示使用ASR普通话基础模型。'."\n" + .'> - 如果二者同时设置，请确认二者是正确对应的。', 'type' => 'string', 'required' => false, 'example' => 'customer_service_8k'], + ], + [ + 'name' => 'StreamAsr', + 'in' => 'query', + 'schema' => ['description' => '流式ASR，根据用户说的前几个字智能判断语义。取值：'."\n" + ."\n" + .'- **0**：关闭。'."\n" + .'- **1**：开启。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1'], + ], + [ + 'name' => 'BackgroundFileCode', + 'in' => 'query', + 'schema' => ['description' => '用户和机器人对话时播放的背景语音文件ID。'."\n" + ."\n" + .'您可以登录[语音服务控制台](https://dyvms.console.aliyun.com/overview/home)，选择**语音文件管理**>**智能语音交互放音文件**，单击**详情**按钮，查看对应的语音ID。', 'type' => 'string', 'required' => false, 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav'], + ], + [ + 'name' => 'BackgroundVolume', + 'in' => 'query', + 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '4', 'minimum' => '-4', 'example' => '1'], + ], + [ + 'name' => 'BackgroundSpeed', + 'in' => 'query', + 'schema' => ['description' => '参数暂不支持使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'EnableITN', + 'in' => 'query', + 'schema' => ['description' => '是否在后处理中执行ITN。默认为**false**，即不执行。'."\n" + ."\n" + .'设置为**true**时，中文数字将转为阿拉伯数字输出。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + ], + [ + 'name' => 'NoiseThreshold', + 'in' => 'query', + 'schema' => ['type' => 'number', 'format' => 'double', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -7003,141 +13051,211 @@ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'- 返回OK代表请求成功。'."\n" - .'- 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Token' => [ - 'description' => 'Token。', - 'type' => 'string', - 'example' => 'eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD', - ], - 'Success' => [ - 'description' => '接口调用是否成功。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + 'CallId' => ['description' => '此次通话的唯一回执ID。'."\n" + ."\n" + .'CallId可以通过[QueryCallDetailByCallId](~~QueryCallDetailByCallId~~)接口查询呼叫详情。', 'type' => 'string', 'example' => '116012854210^10281427****'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"CallId\\": \\"116012854210^10281427****\\"\\n}","errorExample":""},{"type":"xml","example":"<SmartCallResponse>\\n<Message>OK</Message>\\n<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n<CallId>116012854210^10281427****</CallId>\\n<Code>OK</Code>\\n</SmartCallResponse>","errorExample":""}]', + 'title' => '发起智能语音交互通话', + 'summary' => '智能语音交互服务，是一种人机交互技术，它允许用户通过语音与机器进行自然的对话和沟通。', + 'description' => '- SmartCall需要与[智能外呼回调HTTP接口](~~112703~~)联合使用，语音平台发起呼叫后会把转换后的语音文本回传给业务方，业务方把下一步的执行动作返回给语音平台。'."\n" + .'- 以下字符不可以在智能语音交互SmartCall回调中出现：`@ = : "" $ { } ^ * ￥`。', + 'requestParamsDescription' => '### 声音风格'."\n" + .'更多声音风格详情，请参见[声音风格列表](https://help.aliyun.com/zh/vms/sound-style)。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCall'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Token\\": \\"eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZi****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetTokenResponse>\\n<Message>OK</Message>\\n<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69DDD</RequestId>\\n<Token>eyJhbGciOiJSUzI1NiIsImtpZCI6ImFjY2Vzc190ZXN0In0.eyJqdGkiOiJUTjhfRzFCaEpETTJ3LWVoeGJZZXRnIiwiaWF0IjoxNjIzMzk0NTI3LCJleHAiOjE2MjMzOTYzMjcsIm5iZiI6MTYyMzM5NDQ2Ny****</Token>\\n<Code>OK</Code>\\n<Success>true</Success>\\n</GetTokenResponse>","errorExample":""}]', - 'title' => '获取认证的Token', - 'summary' => '获取认证的Token。', - 'description' => '### QPS限制'."\n" - .'单用户调用频率：5次/秒。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'RecoverCallInConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SmartCallOperate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52714', + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Number', + 'name' => 'CallId', 'in' => 'query', + 'schema' => ['description' => '通话的唯一回执ID。可通过[SmartCall](~~393526~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => '116012854210^1028142****'], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => ['description' => '在智能外呼通话中，指定被叫号码发起的动作。'."\n" + ."\n" + .'> 当前仅支持参数**parallelBridge**，表示指定动作为被叫号码与呼叫中心坐席桥接。', 'type' => 'string', 'required' => true, 'example' => 'parallelBridge'], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['description' => '扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'Param'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '需要恢复呼入的400号码。', - 'type' => 'string', - 'required' => true, - 'example' => '400***', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '命令执行的结果。取值：'."\n" + .'- **true**：命令执行成功。'."\n" + .'- **false**：命令执行失败。', 'type' => 'boolean', 'example' => 'true'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\"\\n}","errorExample":""},{"type":"xml","example":"<SmartCallOperateResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</SmartCallOperateResponse>","errorExample":""}]', + 'title' => '发起智能语音指定动作', + 'summary' => '在智能外呼通话中发起指定动作，仅用于并行转人工、人工坐席可旁听人机对话等场景。', + 'description' => '在智能语音交互呼出通话中，转接呼叫中心坐席时，可以使用本接口指定被叫号码发起指定动作。'."\n" + ."\n" + .'> 当前仅支持指定动作为被叫号码与呼叫中心坐席桥接。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCallOperate'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'StartRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。可通过[CreateRobotTask](~~CreateRobotTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '104500****'], + ], + [ + 'name' => 'ScheduleTime', + 'in' => 'query', + 'schema' => ['description' => '定时启动时间。格式为yyyy-MM-dd HH:mm:ss。', 'type' => 'string', 'required' => false, 'example' => '2019-06-14 14:55:23'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainApiResponse<Boolean>', - 'description' => 'PlainApiResponse<Boolean>', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '恢复是否成功。取值：'."\n" - .'- true：成功。'."\n" - .'- false：失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应消息。', - 'type' => 'string', - 'example' => '成功', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', 'type' => 'string', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<StartRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StartRobotTaskResponse>","errorExample":""}]', + 'title' => '启动任务或定时启动任务', + 'summary' => '启动智能语音任务或者定时启动智能语音任务。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StartRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', - 'title' => '400呼转号码恢复呼入', - 'summary' => '调用RecoverCallInConfig恢复指定400呼转号码呼入。', ], 'StopCallInConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7150,9 +13268,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '135026', - 'abilityTreeNodes' => [ - 'FEATUREdyvmsRK85FW', - ], + 'abilityTreeNodes' => ['FEATUREdyvmsRK85FW'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -7160,12 +13276,7 @@ [ 'name' => 'Number', 'in' => 'query', - 'schema' => [ - 'description' => '需要停止呼入的400号码。', - 'type' => 'string', - 'required' => true, - 'example' => '400***', - ], + 'schema' => ['description' => '需要停止呼入的400号码。', 'type' => 'string', 'required' => true, 'example' => '400***'], ], ], 'responses' => [ @@ -7175,365 +13286,251 @@ 'description' => '返回信息。', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => '停止呼入是否成功。取值：'."\n" - .'- true：成功。'."\n" - .'- false：失败。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***', - ], - 'Code' => [ - 'description' => '响应码。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '响应消息。', - 'type' => 'string', - 'example' => '成功', - ], + 'Data' => ['description' => '停止呼入是否成功。取值：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'a78278ff-26bb-48ec-805c-26a0f4c102***'], + 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => '成功'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameters', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"a78278ff-26bb-48ec-805c-26a0f4c102***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', 'title' => '400呼转号码停止呼入', 'summary' => '调用StopCallInConfig接口停止指定400呼转号码呼入。', - ], - 'CancelCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCallInConfig'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:StopCallInConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopRobotTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'CallId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '此次通话的唯一回执ID。可以从[ClickToDial](https://help.aliyun.com/document_detail/114040.htm)接口的返回信息中获取。', - 'type' => 'string', - 'required' => true, - 'example' => '116012854210^10281427****', - ], + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。调用[CreateRobotTask](~~CreateRobotTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045001'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '是否成功取消呼叫。取值：'."\n" - ."\n" - .'- **true**：成功'."\n" - .'- **false**：失败', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '状态码的描述。', - 'type' => 'string', - 'example' => 'OK', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '是否成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', 'type' => 'string', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelCallResponse>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\r\\n\\t<Status>true</Status>\\r\\n</CancelCallResponse>","errorExample":""}]', - 'title' => '取消语音双呼', - 'summary' => '调用CancelCall接口取消ClickToDial发起的语音双呼。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<StopRobotTaskResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>true</Data>\\n</StopRobotTaskResponse>","errorExample":""}]', + 'title' => '暂停智能语音任务', + 'summary' => '暂停开始执行后的智能语音任务。', + 'description' => '- 智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + .'- 暂停任务后，您可以调用[StartRobotTask](~~StartRobotTask~~)接口启动任务。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'QueryVmsVirtualNumberRelationByPage' => [ - 'summary' => '查询虚拟号码与真实号码绑定关系列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRobotTask'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StopRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'SubmitHotlineTransferRegister' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'TransferPhoneNumberInfos', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '', - 'description' => '每页返回的结果个数。 取值范围：1~100。 默认值：20。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', + 'description' => '号码备案信息。', + 'type' => 'array', + 'items' => [ + 'description' => '号码备案信息。', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => ['description' => '备案号码。', 'type' => 'string', 'required' => true, 'example' => '1580000****'], + 'PhoneNumberOwnerName' => ['description' => '机主真实姓名或公司名。', 'type' => 'string', 'required' => true, 'example' => 'A***'], + 'IdentityCard' => ['description' => '机主身份证号。', 'type' => 'string', 'required' => true, 'example' => '500***'], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, ], ], [ - 'name' => 'PageNo', + 'name' => 'QualificationId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '页码。默认取值为**1**。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '74', - ], + 'schema' => ['description' => '资质ID。您可以通过[GetHotlineQualificationByOrder](~~393548~~)接口获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000004933****'], ], [ - 'name' => 'VirtualNumber', + 'name' => 'OperatorName', 'in' => 'query', - 'schema' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'required' => false, - 'example' => '0571****1234', - ], + 'schema' => ['description' => '经办人姓名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'A***'], ], [ - 'name' => 'RealNumber', + 'name' => 'OperatorMail', 'in' => 'query', - 'schema' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'required' => false, - 'example' => '131***1234', - ], + 'schema' => ['description' => '经办人邮箱。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com'], ], [ - 'name' => 'State', + 'name' => 'OperatorMailVerifyCode', 'in' => 'query', - 'schema' => [ - 'title' => '状态 1:有效；0:无效；-1:注销', - 'description' => '状态。可选值：'."\n" - ."\n" - .'- 1：有效'."\n" - .'- 0：无效'."\n" - .'- -1：注销', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '经办人邮箱验证码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1234'], ], [ - 'name' => 'NumberCity', + 'name' => 'OperatorMobile', 'in' => 'query', - 'schema' => [ - 'title' => '号码归属地--城市', - 'description' => '号码归属地--城市', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '经办人手机号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '158****7230'], ], [ - 'name' => 'NumberProvince', + 'name' => 'OperatorMobileVerifyCode', 'in' => 'query', - 'schema' => [ - 'title' => '号码归属地--省', - 'description' => '号码归属地--省', - 'type' => 'string', - 'required' => false, - 'example' => '北京', - ], + 'schema' => ['description' => '经办人手机验证码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234'], + ], + [ + 'name' => 'OperatorIdentityCard', + 'in' => 'query', + 'schema' => ['description' => '经办人身份证号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5****************9'], + ], + [ + 'name' => 'Agreement', + 'in' => 'query', + 'schema' => ['description' => '确认承诺书真实性。取值：'."\n" + ."\n" + .'- **true**：真实。'."\n" + .'- **false**：不真实。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true'], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => ['description' => '400号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '400****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '已失效参数，请忽略', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'title' => '', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '01A58FA5-422C-58E0-AA71-B307A665416F', - ], - 'Message' => [ - 'title' => '', - 'description' => '返回结果的提示信息。', - 'type' => 'string', - 'example' => '参数缺失！', - ], - 'Model' => [ - 'title' => '', - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'title' => '', - 'description' => '每页显示的条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '65', - ], - 'Total' => [ - 'title' => '', - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '231', - ], - 'PageNo' => [ - 'title' => '', - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Data' => [ - 'title' => '', - 'description' => '返回对象列表', - 'type' => 'array', - 'items' => [ - 'description' => '返回对象。', - 'type' => 'object', - 'properties' => [ - 'RealNumber' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'example' => '131****1234', - ], - 'VirtualNumber' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'example' => '0571***1234', - ], - 'State' => [ - 'title' => '状态 1:有效；0:无效；-1:注销', - 'description' => '状态。可选址：'."\n" - .'- 1：有效；'."\n" - .'- 0：无效；'."\n" - .'- -1：注销。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NumberCity' => [ - 'title' => '号码归属地--城市', - 'description' => '号码归属地--城市', - 'type' => 'string', - 'example' => '北京', - ], - 'NumberProvince' => [ - 'title' => '号码归属地--省', - 'description' => '号码归属地--省', - 'type' => 'string', - 'example' => '北京', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'title' => '', - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](~~112502~~)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '', - 'description' => '接口调用是否成功。'."\n" - ."\n" - .'- true：调用成功。'."\n" - ."\n" - .'- false：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '备案ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2258****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6086693B-2250-17CE-A41F-06259AB6DB1B'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"01A58FA5-422C-58E0-AA71-B307A665416F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"PageSize\\": 65,\\n \\"Total\\": 231,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"RealNumber\\": \\"131****1234\\",\\n \\"VirtualNumber\\": \\"0571***1234\\",\\n \\"State\\": 1,\\n \\"NumberCity\\": \\"北京\\",\\n \\"NumberProvince\\": \\"北京\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '查询虚拟号码与真实号码绑定关系列表', - ], - 'QueryVmsRealNumberCallConnectionRateInfo' => [ - 'summary' => '查询真实号接通率', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameters', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Mobile.Invalid', 'errorMessage' => 'The mobile number is invalid.', 'description' => ''], + ['errorCode' => 'MobileVerifyCode.Invalid', 'errorMessage' => 'The mobile verification code is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"6086693B-2250-17CE-A41F-06259AB6DB1B\\"\\n}","type":"json"}]', + 'title' => '提交号码备案', + 'summary' => '您在设置400号码转呼号码前，需要对转呼的号码提交号码备案。', + 'description' => '### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotlineTransferRegister'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SubmitHotlineTransferRegister', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpgradeVideoFile' => [ + 'summary' => '从语音通话升级到视频通话。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7542,364 +13539,899 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'abilityTreeCode' => '217976', + 'abilityTreeNodes' => ['FEATUREdyvmsL1CC4Y'], ], 'parameters' => [ [ - 'name' => 'VirtualNumber', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'title' => '虚拟号码', - 'description' => '虚拟号码', - 'type' => 'string', - 'required' => false, - 'example' => '0571***1234', - ], + 'schema' => ['description' => '通话ID。您可以在[SingleCallByVideo](https://help.aliyun.com/zh/vms/developer-reference/api-dyvmsapi-2017-05-25-singlecallbyvideo?spm)接口返回参数中获取CallId。', 'type' => 'string', 'required' => false, 'example' => '116012354148^10281378****'], ], [ - 'name' => 'RealNumber', + 'name' => 'MediaType', 'in' => 'query', - 'schema' => [ - 'title' => '真实号码', - 'description' => '真实号码', - 'type' => 'string', - 'required' => false, - 'example' => '131***1234', - ], + 'schema' => ['description' => '媒体类型。固定取值：**video**。', 'type' => 'string', 'required' => false, 'example' => 'video', 'default' => 'VIDEO'], ], [ - 'name' => 'TimePeriod', + 'name' => 'OutId', 'in' => 'query', + 'schema' => ['description' => '预留给调用方的ID，最终会通过回执消息将此ID带回给调用方。'."\n" + ."\n" + .'字符串类型，长度限制为1~15个字符。', 'type' => 'string', 'required' => false, 'example' => '225869*****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '接收视频通话的手机号码。', 'type' => 'string', 'required' => true, 'example' => '159****0000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '时间段', - 'description' => '时间段（起始毫秒时间戳-结束毫秒时间戳）', - 'type' => 'string', - 'required' => false, - 'example' => '1764666240123-1764686240567', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '无'], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'], + 'Data' => ['description' => '返回的数据内容。', 'type' => 'object'], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码详见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Success' => ['description' => '接口调用是否成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '视频升级', + 'description' => '目前5G视频通话功能处于邀约制阶段，您需要联系运营经理为您开通此功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeVideoFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:UpgradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], ], + ], + 'UploadRobotTaskCalledFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '机器人呼叫任务的唯一任务ID。可通过[CreateRobotTask](~~CreateRobotTask~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1045****'], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => '被叫号码。多个号码之间使用半角逗号（,）分隔。'."\n" + ."\n" + .'> 在创建智能语音机器人任务后，需要分批上传被叫号码，每个任务最多上传30万个号码，可分多次上传完成。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1370****000,1370****111'], + ], + [ + 'name' => 'TtsParam', + 'in' => 'query', + 'schema' => ['description' => 'TTS模板的变量值。格式为JSON。TtsParam和TtsParamHead变量名称一一对应。'."\n" + ."\n" + .'- 如果全部号码携带的参数相同，可将number字段里的值写为**all**，变量值仅需上传一份即可。'."\n" + .'- 如果部分号码携带的参数相同，可将number字段里的值写为**all**，其他号码正常输入number值和对应的变量值，系统会优先取号码自带值。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '[{"number":"1370****000","params":["小王","小李","小周"]}]'], + ], + [ + 'name' => 'TtsParamHead', + 'in' => 'query', + 'schema' => ['description' => '带变量的呼叫任务。格式为JSON。变量名称列表，和TtsParam配合使用。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["name1","name2","name3"]'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '本组参数已弃用，请忽略。', - 'type' => 'string', - 'example' => '无', - ], - 'RequestId' => [ - 'title' => '', - 'description' => '请求ID', - 'type' => 'string', - 'example' => '95B86652-B234-5387-BAC6-E441FR49399F', - ], - 'Message' => [ - 'title' => '', - 'description' => '返回结果的提示信息。', - 'type' => 'string', - 'example' => '参数缺失！', - ], - 'Model' => [ - 'title' => '', - 'description' => '请求结果数据', - 'type' => 'object', - 'properties' => [ - 'RingingRate' => [ - 'title' => '响铃率', - 'description' => '响铃率', - 'type' => 'number', - 'format' => 'double', - 'example' => '25.4222', - ], - 'ResourceId' => [ - 'title' => '', - 'description' => '弃用参数，请忽略', - 'type' => 'string', - 'example' => '无', - ], - 'RingingCount' => [ - 'title' => '响铃数', - 'description' => '响铃数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ResourceType' => [ - 'title' => 'EcsInstance, EcsDisk, EcsImage, EcsSnapshot, EcsSecurityGroup, EcsEip, EcsVpc, EcsVRouter, EcsVSwitch, EcsVRouteTable, EcsAuthImage, EcsAll, SlbLoadbalancer, SlbVm, RdsInstance, RdsAllInstance, KvsInstance, OcsInstance, OdpsInstance', - 'description' => '弃用参数，请忽略', - 'type' => 'string', - 'example' => '无', - ], - 'RegionId' => [ - 'title' => '', - 'description' => '弃用参数，请忽略', - 'type' => 'string', - 'example' => '无', - ], - 'CallConnectionRate' => [ - 'title' => '接通率', - 'description' => '接通率', - 'type' => 'number', - 'format' => 'double', - 'example' => '6.71672', - ], - 'RequestCount' => [ - 'title' => '请求通话数', - 'description' => '请求通话数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'CompleteCount' => [ - 'title' => '接通数', - 'description' => '接通数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'title' => '', - 'description' => '请求状态码。'."\n" - .'* 返回OK代表请求成功。'."\n" - .'* 其他错误码，请参见[API错误码](https://help.aliyun.com/zh/vms/developer-reference/api-error-code?spm=a2c4g.11186623.0.0.321526dckd3diO)。', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '', - 'description' => '请求是否成功。'."\n" - .'- **true**：调用成功。'."\n" - ."\n" - .'- **false**：调用失败。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~112502~~)。', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'], + 'Data' => ['description' => '机器人呼叫任务的唯一任务ID。'."\n" + ."\n" + .'可通过此ID调用[QueryRobotTaskDetail](~~QueryRobotTaskDetail~~)接口查询任务详情。', 'type' => 'string', 'example' => '10450****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10450****\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\"\\n}","errorExample":""},{"type":"xml","example":"<UploadRobotTaskCalledFileResponse>\\n\\t<Message>OK</Message>\\n\\t<RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n\\t<Code>OK</Code>\\n\\t<Data>10450****</Data>\\n</UploadRobotTaskCalledFileResponse>","errorExample":""}]', + 'title' => '上传智能语音的被叫号码', + 'summary' => '上传智能语音任务的被叫号码。', + 'description' => '智能语音机器人功能升级，老功能将于2023.12.31停止服务，新功能请登录[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)，在**智能外呼机器人**页面开通使用。老客户（语音服务已开通该功能的客户）目前可继续使用该功能，为避免给您带来业务损失，请在2023.12.31前完成业务迁移。'."\n" + ."\n" + .'### QPS限制'."\n" + .'单用户调用频率：100次/秒。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadRobotTaskCalledFile'], + ], + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:UploadRobotTaskCalledFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"95B86652-B234-5387-BAC6-E441FR49399F\\",\\n \\"Message\\": \\"参数缺失！\\",\\n \\"Model\\": {\\n \\"RingingRate\\": 25.4222,\\n \\"ResourceId\\": \\"无\\",\\n \\"RingingCount\\": 3,\\n \\"ResourceType\\": \\"无\\",\\n \\"RegionId\\": \\"无\\",\\n \\"CallConnectionRate\\": 6.71672,\\n \\"RequestCount\\": 49,\\n \\"CompleteCount\\": 52\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => '查询真实号接通率', ], ], 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'dyvmsapi.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => 'dyvmsapi.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => 'dyvmsapi-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyvmsapi.aliyuncs.com', 'endpoint' => 'dyvmsapi.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => '100008.0', 'message' => 'Data not available.', 'http_code' => 400, 'description' => '数据不存在'], + ['code' => 'BillidNotExist', 'message' => 'The bill ID does not exist.', 'http_code' => 400, 'description' => '号码不存在'], + ['code' => 'ComplaintReject', 'message' => 'The call has been blocked due to complaints.', 'http_code' => 400, 'description' => '投诉拦截'], + ['code' => 'InternalError', 'message' => 'An internal server error occurred.', 'http_code' => 500, 'description' => '服务器内部错误'], + ['code' => 'InvalidParameter.date', 'message' => 'date not invalid.', 'http_code' => 400, 'description' => '日期无效。'], + ['code' => 'InvalidParameters', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => '无效参数'], + ['code' => 'InvalidParameters', 'message' => 'Invalid Parameters.', 'http_code' => 400, 'description' => '参数非法。'], + ['code' => 'isp.GATEWAY_ERROR', 'message' => 'Gateway error.', 'http_code' => 500, 'description' => '系统异常'], + ['code' => 'isp.RAM_PERMISSION_DENY', 'message' => 'The RAM permission is denied.', 'http_code' => 400, 'description' => 'RAM权限DENY'], + ['code' => 'isp.RES_OWNER_ID_UNKNOWN', 'message' => 'The Alibaba Cloud account is not found.', 'http_code' => 400, 'description' => '找不到资源归属的阿里云ID'], + ['code' => 'isp.SYSTEM_ERROR', 'message' => 'System error.', 'http_code' => 500, 'description' => '系统错误'], + ['code' => 'isp.UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 400, 'description' => '未知异常'], + ['code' => 'isp.USER_ASSERT_NOT_EXIST', 'message' => 'Failed to obtain user information.', 'http_code' => 400, 'description' => '用户信息获取失败'], + ['code' => 'isp.USER_NOT_EXIST', 'message' => 'The user information does not exist.', 'http_code' => 400, 'description' => '用户信息不存在'], + ['code' => 'isv.ACCOUNT_ABNORMAL', 'message' => 'Account is abnormal.', 'http_code' => 400, 'description' => '账户异常'], + ['code' => 'isv.ACCOUNT_NOT_EXISTS', 'message' => 'The account is not found.', 'http_code' => 400, 'description' => '账户不存在'], + ['code' => 'isv.AMOUNT_NOT_ENOUG', 'message' => 'Insufficient account balance.', 'http_code' => 400, 'description' => '账户余额不足'], + ['code' => 'isv.ASR_MODEL_ERROR', 'message' => 'No permissions to use the ASR model.', 'http_code' => 400, 'description' => '无权使用ASR模型'], + ['code' => 'isv.BILLID_NOT_EXIST', 'message' => 'Billid is not found.', 'http_code' => 400, 'description' => '计费账号未找到'], + ['code' => 'isv.BLACK_KEY_CONTROL_LIMIT', 'message' => 'Blacklist keyword exists in template variables.', 'http_code' => 400, 'description' => '模板变量中存在黑名单关键字'], + ['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => 'Throttling has been triggered.', 'http_code' => 400, 'description' => '触发业务流控限制。流控限制分为分钟级、小时级和天级共三种'], + ['code' => 'isv.BUSINESS_LIMIT_CONTROL', 'message' => 'The business limit has been reached.', 'http_code' => 400, 'description' => '业务流控'], + ['code' => 'isv.COMPLAINT_REJECT', 'message' => 'Stopped by nuisance blocker.', 'http_code' => 400, 'description' => '防骚扰拦截'], + ['code' => 'isv.DISPLAY_NUMBER_ILLEGAL', 'message' => 'Invalid display number.', 'http_code' => 400, 'description' => '号显不合法'], + ['code' => 'isv.HIT_VOICE_SECURITY_RULE', 'message' => 'Stopped by security control.', 'http_code' => 400, 'description' => '安全管控拦截'], + ['code' => 'isv.INVALID_JSON_PARAM', 'message' => 'Invalid JSOM parameter.', 'http_code' => 400, 'description' => 'JSON参数不合法'], + ['code' => 'isv.INVALID_PARAMETERS', 'message' => 'Parameters are invalid.', 'http_code' => 400, 'description' => '参数异常'], + ['code' => 'isv.MOBILE_COUNT_OVER_LIMIT', 'message' => 'The maximum number of phone numbers has been exceeded.', 'http_code' => 400, 'description' => '手机号码数量超过限制'], + ['code' => 'isv.MOBILE_NUMBER_ILLEGAL', 'message' => 'Invalid phone number format.', 'http_code' => 400, 'description' => '号码格式非法'], + ['code' => 'isv.OUT_OF_SERVICE', 'message' => 'Account is out of service.', 'http_code' => 400, 'description' => '业务停机'], + ['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => 'Invalid template parameter length.', 'http_code' => 400, 'description' => '模板参数长度非法'], + ['code' => 'isv.PARAM_LENGTH_LIMIT', 'message' => 'The parameter value length is over the limit.', 'http_code' => 400, 'description' => '参数长度受限'], + ['code' => 'isv.PARAM_NOT_SUPPORT_URL', 'message' => 'URLs are not supported for the parameter.', 'http_code' => 400, 'description' => '变量不支持URL参数'], + ['code' => 'isv.PHONE_NUMBER_IN_BLACK_LIST', 'message' => 'Phone number is in the blacklist.', 'http_code' => 400, 'description' => '号码黑名单'], + ['code' => 'isv.PRODUCT_UNSUBSCRIBE', 'message' => 'The product has not been activated.', 'http_code' => 400, 'description' => '产品未开通'], + ['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => 'Cloud Communications have not been enabled for the account.', 'http_code' => 400, 'description' => '未开通云通信产品的阿里云客户'], + ['code' => 'isv.RAM_CHECK_FAILED', 'message' => 'RAM authentication failed.', 'http_code' => 400, 'description' => 'RAM权限校验失败'], + ['code' => 'isv.TEMPLATE_ILLEGAL', 'message' => 'The template is invalid or does not exist.', 'http_code' => 400, 'description' => '模板非法或不存在（已拉黑）'], + ['code' => 'isv.TEMPLATE_MISSING_PARAMETERS', 'message' => 'Template parameters are missing.', 'http_code' => 400, 'description' => '模板参数缺失'], + ['code' => 'isv.TEMPLATE_MISSING_PARAMETERS', 'message' => 'TTS template parameters are required.', 'http_code' => 400, 'description' => '文本转语音模板参数缺失'], + ['code' => 'isv.TEMPLATE_PARAMS_ILLEGAL', 'message' => 'Invalid template variable.', 'http_code' => 400, 'description' => '模板变量非法'], + ['code' => 'isv.TTS_TEMPLATE_ILLEGAL', 'message' => 'Invalid TTS template.', 'http_code' => 400, 'description' => 'TTS模板不合法'], + ['code' => 'isv.VOICE_CALL_FAIL', 'message' => 'Voice call failed.', 'http_code' => 400, 'description' => '呼叫发起失败'], + ['code' => 'isv.VOICE_CALL_PERIOD_ERROR', 'message' => 'Failed to obtain voice call periods.', 'http_code' => 400, 'description' => '获取语音呼叫时段失败'], + ['code' => 'isv.VOICE_CODE_PARAM_ILLEGAL', 'message' => 'The voice code parameter is invalid.', 'http_code' => 400, 'description' => '语音Code参数非法'], + ['code' => 'isv.VOICE_FILE_ILLEGAL', 'message' => 'Invalid voice file.', 'http_code' => 400, 'description' => '语音文件不合法'], + ['code' => 'isv.VOICE_ROBOT_CALLEE_LIMIT', 'message' => 'A maximum of 1,000 callee numbers are allowed.', 'http_code' => 400, 'description' => '被叫号码超过1000'], + ['code' => 'isv.VOICE_ROBOT_ID_NULL', 'message' => 'The voice robot is not found.', 'http_code' => 400, 'description' => 'robot数据没有查到'], + ['code' => 'isv.VOICE_ROBOT_NOT_AUDIT', 'message' => 'The voice robot failed to pass the review.', 'http_code' => 400, 'description' => 'robot没有审核通过'], + ['code' => 'isv.VOICE_ROBOT_NOT_PERIOD', 'message' => 'The message sending time cannot be within the limit period.', 'http_code' => 400, 'description' => '发送时间不能在限制时段内'], + ['code' => 'Mobile.Invalid', 'message' => 'The mobile number is invalid.', 'http_code' => 400, 'description' => '号码格式错误'], + ['code' => 'MobileVerifyCode.Invalid', 'message' => 'The mobile verification code is invalid.', 'http_code' => 400, 'description' => '手机验证码有误'], + ['code' => 'Query.Voice.File.Limit', 'message' => 'Voice file query number cannot exceed 10', 'http_code' => 400, 'description' => '语音文件查询数量不能超过10个'], + ['code' => 'RecordData.Query.Fail', 'message' => 'Failed to query records.', 'http_code' => 500, 'description' => '查询记录失败'], + ['code' => 'REGISTER_400_QUALIFICATION_NOT_EXIS', 'message' => '400 qualification is not under the current customer or is invalid.', 'http_code' => 400, 'description' => '400资质不在当前客户下或无效。'], + ['code' => 'REGISTER_400_QUALIFICATION_NOT_EXIST_ERROR', 'message' => '400 qualification not exist or valid under custId.', 'http_code' => 400, 'description' => '400资质不存在或者不属于当前账号'], + ['code' => 'STOCK_UNKNOWN_ERROR', 'message' => 'System exception.', 'http_code' => 400, 'description' => '系统异常'], + ['code' => 'UnauthorizedOperation', 'message' => 'You have not been authorized.', 'http_code' => 400, 'description' => '未开通权限'], + ['code' => 'User.Query.Fail', 'message' => 'Failed to query user information.', 'http_code' => 500, 'description' => '查询用户信息失败'], + ['code' => 'VirtualNumber.NotOwn', 'message' => 'You can only use your own virtual number.', 'http_code' => 400, 'description' => '不能使用非自己所属的虚拟号码'], + ['code' => 'VirtualNumber.Query.Fail', 'message' => 'Failed to query virtual numbers.', 'http_code' => 500, 'description' => '查询虚拟号码失败'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInTransferRecord'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DegradeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PlayVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByTaskId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVideo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotv2AllList'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByTts'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotInfoList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExecuteCallTask'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IvrCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitHotlineTransferRegister'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskCallList'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineQualificationByOrder'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SkipVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelOrderRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetTransferCalleePoolConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadRobotTaskCalledFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCallOperate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineTransferRegisterFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemporaryFileUrl'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRobotTaskDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendVerification'], + ['threshold' => '1200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SingleCallByVoice'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddVirtualNumberRelation'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVirtualNumberRelation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTaskDetail'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRobotTask'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallDetailByCallId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopRobotTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVoiceFileAuditInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchRobotSmartCall'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetToken'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmartCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallMediaType'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryCallInPoolTransferConfig'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeVideoFile'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryVideoPlayProgress'], ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'dyvmsapi.aliyuncs.com', + 'product' => ['code' => 'dyvms', 'title' => '语音服务'], + ], + 'ram' => [ + 'productCode' => 'VoiceMessagingService', + 'productName' => '语音服务', + 'ramCodes' => ['dyvms'], + 'ramLevel' => '操作级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DegradeVideoFile', + 'description' => '视频降级', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:DegradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SmartCall', + 'description' => '发起智能语音交互通话', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelOrderRobotTask', + 'description' => '取消智能语音任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelOrderRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetHotlineQualificationByOrder', + 'description' => '获取400号码资质ID', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetHotlineQualificationByOrder', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitHotlineTransferRegister', + 'description' => '提交号码备案', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SubmitHotlineTransferRegister', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SetTransferCalleePoolConfig', + 'description' => '设置400号码呼转', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SetTransferCalleePoolConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallInTransferRecord', + 'description' => '查询400号码呼转记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInTransferRecord', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'BatchRobotSmartCall', + 'description' => '批量发起智能语音机器人外呼任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:BatchRobotSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallDetailByCallId', + 'description' => '查询指定通话的呼叫详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByCallId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVirtualNumberRelation', + 'description' => '查询服务实例与真实号码绑定关系列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskCallDetail', + 'description' => '查询智能机器人任务执行详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallDetailByTaskId', + 'description' => '查看指定机器人外呼任务的话单详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallDetailByTaskId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateRobotTask', + 'description' => '发起智能语音机器人外呼任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PauseVideoFile', + 'description' => '暂停视频', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PauseVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVideoPlayProgress', + 'description' => '查询视频进度', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:QueryVideoPlayProgress', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelCall', + 'description' => '取消语音双呼', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:CancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskDetail', + 'description' => '获取智能语音任务详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartRobotTask', + 'description' => '启动任务或定时启动任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StartRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotv2AllList', + 'description' => '获取全部机器人话术模板列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotv2AllList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SmartCallOperate', + 'description' => '发起智能语音指定动作', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SmartCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListHotlineTransferRegisterFile', + 'description' => '获取号码备案信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:ListHotlineTransferRegisterFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryVoiceFileAuditInfo', + 'description' => '查询语音文件审核状态', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryVoiceFileAuditInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopRobotTask', + 'description' => '暂停智能语音任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:StopRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpgradeVideoFile', + 'description' => '视频升级', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:UpgradeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'IvrCall', + 'description' => '向指定号码发起交互式语音通话', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:IvrCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteCallTask', + 'description' => '执行语音通话任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:ExecuteCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryCallInPoolTransferConfig', + 'description' => '查询400号码呼转配置详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryCallInPoolTransferConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCallTask', + 'description' => '获取通话任务状态列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteRobotTask', + 'description' => '删除智能语音任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dyvms:DeleteRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByVideo', + 'description' => '发送视频通知', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVideo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ResumeVideoFile', + 'description' => '恢复视频', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:ResumeVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskList', + 'description' => '获取所有任务ID', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendVerification', + 'description' => '发送短信验证码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SendVerification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotInfoList', + 'description' => '查询智能语音机器人列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotInfoList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRobotTaskCallList', + 'description' => '查询任务内执行条目列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:QueryRobotTaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelRobotTask', + 'description' => '终止智能语音任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:CancelRobotTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddVirtualNumberRelation', + 'description' => '批量添加服务实例与真实号码绑定关系', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:AddVirtualNumberRelation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UploadRobotTaskCalledFile', + 'description' => '上传智能语音的被叫号码', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:UploadRobotTaskCalledFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PlayVideoFile', + 'description' => '插播视频', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:PlayVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateCallTask', + 'description' => '创建语音通话任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dyvms:CreateCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByTts', + 'description' => '发送语音验证码或文本转语音类型的语音通知', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SingleCallByVoice', + 'description' => '发送语音通知文件类型的语音通知', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dyvms:SingleCallByVoice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetToken', + 'description' => '获取认证的Token', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dyvms:GetToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCallTaskDetail', + 'description' => '获取通话任务详情列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dyvms:ListCallTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SkipVideoFile', + 'description' => '快进或后退视频', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dyvms:SkipVideoFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'VoiceMessagingService', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; |