API标准及多语言预置SDK
本产品（Dyvmsapi/2017-05-25）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
行业云联络中心
|
API |
标题 |
API概述 |
| 其他 | 其他 | |
| CloudAgentWorkloadReport | 获取座席工作量报表数据 | 获取座席工作量报表数据。 |
| CloudQueryRasrEvent | 获取RASR信息 | 通过uniqueId获取rasr信息。 |
| CloudGetAsr | ASR查询任务结果 | 查询ASR任务结果，获取数据。 |
| CloudGetAreaCode | 号码归属地查询 | 号码归属地查询。 |
| 通话记录 | 通话记录 | |
| CloudQueryWebcallCdr | 获取webCall通话记录 | 通过本接口，可以查询webCall通话记录信息。 |
| CloudQueryPredictiveCallCdr | 预测式外呼通话记录 | 通过本接口，可以查询预测式外呼通话记录信息。 |
| CloudQueryObCdr | 获取座席外呼通话记录 | 根据条件查询座席外呼通话记录。 |
| CloudQueryIbCdr | 获取来电通话记录 | 通过本接口，可以根据条件查询来电通话记录。 |
| CloudOutboundPreviewObReport | 获取预览外呼报表 | 获取预览外呼报表。 |
| CloudOutboundObClidReport | 预览外呼主叫号码报表 | 获取预览外呼主叫报表数据。 |
| CloudGetRecordUrl | 获取通话录音地址 | 通过本接口，可以根据录音文件名获取录音试听或下载地址。 |
| CloudGetObCdr | 获取座席外呼通话记录详情 | 通过本接口，可以根据电话唯一标识查询指定座席外呼通话记录详情。 |
| CloudCreateAsr | 创建ASR转换任务 | 上传录音文件，创建ASR创建转换任务。 |
| 日志 | 日志 | |
| CloudListCurlLog | 推送日志查询 | 查询用户推送日志。 |
| 呼叫配置管理 | 呼叫配置管理 | |
| CloudListSkill | 查询技能列表 | 查询技能信息列表。 |
| CloudListQueueSkill | 获取队列技能 | 获取队列技能信息。 |
| CloudListQueue | 获取队列列表 | 查询队列信息列表。 |
| CloudListExten | 获取分机列表 | 查询分机信息列表。 |
| CloudListAssignedAgentGroup | 获取外呼组下座席组列表 | 通过本接口，可以进行查询获取外呼组下的座席列表。 |
| CloudListAgentGroup | 获取外呼组列表 | 通过本接口，可以进行查询获取外呼组列表。 |
| CloudDeleteQueueSkill | 队列删除技能 | 队列删除技能。 |
| CloudGetQueue | 获取队列信息 | 查询队列信息。 |
| CloudGetExten | 查询分机 | 查询指定分机信息。 |
| CloudDeleteSkill | 删除技能 | 删除技能。 |
| CloudDeleteQueue | 删除队列 | 删除队列。 |
| CloudDeleteExten | 删除分机 | 根据分机号删除分机。 |
| CloudDeleteEnterpriseTime | 删除时间条件设置 | 删除时间条件设置。 |
| CloudDeleteAgentGroup | 删除外呼组 | 通过本接口，可以进行删除外呼组操作。 |
| CloudCreateSkill | 新增技能 | 通过此接口新增一个技能。 |
| CloudCreateQueueSkill | 队列新增技能 | 队列增加技能。 |
| CloudCreateQueue | 新增队列 | 用过此接口新增队列。 |
| CloudCreateExten | 新增分机 | 通过此接口新增分机。 |
| CloudCreateEnterpriseTime | 新增时间条件设置 | 通过本接口，可以新增时间条件设置配置。 |
| CloudCreateAgentGroup | 新增外呼组 | 通过本接口，可以进行新增外呼组操作。 |
| CloudAssignAgentGroup | 外呼组分配座席 | 通过本接口，可以将座席分配到外呼组。 |
| 座席Action接口 | 座席Action接口 | |
| CloudWebcall | webcall接口 | 通过本接口，第三方平台可以给托管型呼叫中心发送呼叫请求，系统分别呼叫客户和座席，先呼叫客户再呼叫座席,并把双方接通。 |
| CloudPreviewoutcall | 座席外呼 | 当座席在线时，通过此接口进行呼叫。 |
| CloudInterruptIvr | IVR等待打断 | 如果当前通话在语音导航的等待节点，通过此接口可以打断等待，执行到下一跳。 |
| CloudAgentUnlink | 座席挂机 | 座席挂机。 |
| CloudAgentSetUserData | 座席设置随路数据 | 使用此接口设置座席随路数据。 |
| CloudAgentLogin | 座席上线 | 使用此接口将座席上线。 |
| CloudAgentLogout | 座席下线 | 下线座席。 |
| 座席管理接口 | 座席管理接口 | |
| CloudUnassignAgentGroup | 解绑外呼组 | 通过本接口，可以清除外呼组与座席的绑定关系。 |
| CloudAgentMonitorStatistics | 座席实时统计 | 实时统计座席通话数据。 |
| CloudQueryAgentSkill | 获取座席技能 | 通过座席工号查询座席技能。 |
| CloudQueryAgentGroup | 获取座席外呼组 | 查询座席所在外呼组的信息。 |
| CloudQueryAgent | 座席详细信息列表获取 | 查询座席详细信息列表。 |
| CloudListAgentTel | 获取座席电话 | 通过座席工号获取座席电话信息。 |
| CloudGetAgentStatus | 座席实时状态获取 | 获取座席实时状态信息。 |
| CloudBatchUpdateAgent | 座席批量更新 | 批量更新座席基本信息，不包含座席绑定的技能信息的更新。 |
| CloudUpdateAgent | 座席更新 | 更新座席基础信息。 |
| CloudQueryAgentCnoAndName | 座席工号名称列表获取 | 获取所有座席工号和名称消息。 |
| CloudListOnlineAgent | 获取在线座席信息 | 查询在线的座席信息列表。 |
| CloudListFreeAgent | 获取在线空闲 | 查询在线的座席列表。 |
| CloudGetAgent | 座席详细信息获取 | 获取某个座席的详细信息。 |
| CloudDeleteAgentTel | 删除座席电话 | 删除座席下的电话。 |
| CloudDeleteAgent | 删除座席 | 根据座席工号删除座席。 |
| CloudBatchGetAgentStatus | 座席实时状态批量获取 | 根据座席工号批量获取座席实时状态。 |
| CloudBatchCreateAgent | 座席批量新增 | 批量新增座席,单次批量创建不能超过100个。 |
| CloudCreateAgent | 创建座席 | 创建一个座席。 |
| 呼叫任务接口 | 呼叫任务接口 | |
| CloudQueryTask | 获取呼叫任务列表 | 获取呼叫任务列表，支持按照条件查询。 |
| CloudMonitorTask | 监控呼叫任务 | 呼叫任务监控。 |
| CloudPauseTask | 呼叫任务暂停 | 通过此接口暂停呼叫任务。 |
| CloudListTaskFile | 获取呼叫任务批次列表 | 获取呼叫任务批次列表信息。 |
| CloudGetTask | 获取呼叫任务信息 | 根据任务Id，获取单个任务的配置信息。 |
| CloudDeleteTaskTel | 呼叫任务号码删除 | 通过此接口删除呼叫任务的号码。 |
| CloudDeleteTask | 删除呼叫任务 | 支持删除预测外呼和自动外呼任务，只有在初始或完成状态的任务才能删除；删除任务时任务的号码也会被删除。 |
| CloudCreateTask | 新增呼叫任务 | 此接口用于新增外呼任务。 |
| CloudImportTaskTel | 任务号码导入 | 为外呼任务导入任务号码。 |
| CloudStartTask | 启动呼叫任务 | 手动启动外呼任务。 |
| CloudUpdateTask | 修改呼叫任务 | 修改外呼任务的基础信息。 |
发送语音通知
|
API |
标题 |
API概述 |
| SingleCallByVoice | 发送语音通知文件类型的语音通知 | 调用接口给单个被叫号码发送语音通知文件类型的语音通知。 |
发送语音验证码
|
API |
标题 |
API概述 |
| SingleCallByTts | 发送语音验证码或文本转语音类型的语音通知 | 调用接口给单个被叫号码发送语音验证码或文本转语音类型的语音通知。 |
语音通话任务
|
API |
标题 |
API概述 |
| CreateCallTask | 创建语音通话任务 | 使用服务实例给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。 |
| ListCallTask | 获取通话任务状态列表 | 创建语音通话任务后，可以查看通话任务状态，包括：任务ID、任务当前状态、任务所选的模板信息等。 |
| ExecuteCallTask | 执行语音通话任务 | 执行通话任务。 |
| ListCallTaskDetail | 获取通话任务详情列表 | 执行完通话任务后根据任务ID，查看指定任务详情。 |
服务实例
|
API |
标题 |
API概述 |
| AddVirtualNumberRelation | 批量添加服务实例与真实号码绑定关系 | 批量添加服务实例与真实号码绑定关系。 |
| QueryVirtualNumberRelation | 查询服务实例与真实号码绑定关系列表 | 查询服务实例与真实号码绑定后的数据列表，包括绑定真实号的时间，号码创建时间，某个服务实例下绑定真实号的数量等。 |
| ListServiceInstanceForPage | 分页查询服务实例列表 | 分页查询服务实例列表 |
查询语音文件审核状态
|
API |
标题 |
API概述 |
| QueryVoiceFileAuditInfo | 查询语音文件审核状态 | 查询语音文件审核状态。 |
查询呼叫详情
|
API |
标题 |
API概述 |
| QueryCallDetailByCallId | 查询指定通话的呼叫详情 | 根据指定通话任务返回的CallID查询呼叫详情，包括通话开始时间、通话时长、通话状态、通话结束时间、被叫号码等详情。 |
交互式语音通话
|
API |
标题 |
API概述 |
| IvrCall | 向指定号码发起交互式语音通话 | 向指定号码发起交互式语音通话。 |
智能语音交互通话
|
API |
标题 |
API概述 |
| SmartCall | 发起智能语音交互通话 | 智能语音交互服务，是一种人机交互技术，它允许用户通过语音与机器进行自然的对话和沟通。 |
| SmartCallOperate | 发起智能语音指定动作 | 在智能外呼通话中发起指定动作，仅用于并行转人工、人工坐席可旁听人机对话等场景。 |
智能语音机器人
|
API |
标题 |
API概述 |
| CreateRobotTask | 发起智能语音机器人外呼任务 | 发起智能语音机器人外呼任务。 |
| BatchRobotSmartCall | 批量发起智能语音机器人外呼任务 | 批量发起智能语音机器人外呼任务，一次任务支持设置1~100个号码。 |
| StartRobotTask | 启动任务或定时启动任务 | 启动智能语音任务或者定时启动智能语音任务。 |
| StopRobotTask | 暂停智能语音任务 | 暂停开始执行后的智能语音任务。 |
| CancelOrderRobotTask | 取消智能语音任务 | 取消还未启动的定时智能语音任务。 |
| CancelRobotTask | 终止智能语音任务 | 终止智能语音任务。 |
| DeleteRobotTask | 删除智能语音任务 | 删除智能语音任务。 |
| QueryRobotv2AllList | 获取全部机器人话术模板列表 | 获取全部机器人话术模板列表。 |
| QueryRobotTaskList | 获取所有任务ID | 获取所有语音任务信息。 |
| QueryCallDetailByTaskId | 查看指定机器人外呼任务的话单详情 | 查看指定机器人外呼任务的话单详情。 |
| QueryRobotTaskDetail | 获取智能语音任务详情 | 获取指定智能语音任务详情。 |
| QueryRobotTaskCallList | 查询任务内执行条目列表 | 查询指定任务内执行条目列表。 |
| QueryRobotInfoList | 查询智能语音机器人列表 | 查看智能语音机器人列表，获取机器人详细信息。 |
| QueryRobotTaskCallDetail | 查询智能机器人任务执行详情 | 获取单个执行条目即单个被叫号码的任务明细。 |
| UploadRobotTaskCalledFile | 上传智能语音的被叫号码 | 上传智能语音任务的被叫号码。 |
400号码
|
API |
标题 |
API概述 |
| GetHotlineQualificationByOrder | 获取400号码资质ID | 通过资质申请工单号获取400号码的资质ID。 |
| ListHotlineTransferRegisterFile | 获取号码备案信息 | 通过SubmitHotlineTransferRegister接口提交备案信息后，通过此接口获取号码备案信息。 |
| SubmitHotlineTransferRegister | 提交号码备案 | 您在设置400号码转呼号码前，需要对转呼的号码提交号码备案。 |
| SetTransferCalleePoolConfig | 设置400号码呼转 | 为400号码设置转呼号码。 |
| QueryCallInPoolTransferConfig | 查询400号码呼转配置详情 | 设置400号码转呼后，通过此接口查询400号码呼转配置详情。 |
| QueryCallInTransferRecord | 查询400号码呼转记录 | 查询呼转记录。 |
| SendVerification | 发送短信验证码 | 发送短信验证码。 |
5G视频通话（邀约制）
|
API |
标题 |
API概述 |
| SingleCallByVideo | 发送视频通知 | 调用接口给单个被叫号码发送语音文件通知或视频文件通知。 |
| PlayVideoFile | 插播视频 | 在语音通话中插播视频文件。 |
| PauseVideoFile | 暂停视频 | 在语音通话中插播视频文件时，暂停视频播放。 |
| ResumeVideoFile | 恢复视频 | 在语音通话中暂停视频播放后，恢复视频播放。 |
| QueryVideoPlayProgress | 查询视频进度 | 在语音通话中插播视频文件后，查询视频播放进度。 |
| UpgradeVideoFile | 视频升级 | 从语音通话升级到视频通话。 |
| DegradeVideoFile | 视频降级 | 从视频通话降级到语音通话。 |
| SkipVideoFile | 快进或后退视频 | 在播放视频时，可以调用此接口快进视频或后退视频。 |
| GetCallMediaType | 获取通话类型 | 在通话时获取通话类型。 |
| GetTemporaryFileUrl | 获取文件临时URL | 获取视频或语音文件临时URL，方便您立即查看视频或语音文件。 |
获取认证Token
|
API |
标题 |
API概述 |
| GetToken | 获取认证的Token | 获取认证的Token。 |
400号码呼转设置
|
API |
标题 |
API概述 |
其他
|
API |
标题 |
API概述 |
| CancelCall | 取消语音双呼 | 调用CancelCall接口取消ClickToDial发起的语音双呼。 |
| QueryVmsVirtualNumberRelationByPage | 查询虚拟号码与真实号码绑定关系列表 | 查询虚拟号码与真实号码绑定关系列表 |
| QueryVmsRealNumberCallConnectionRateInfo | 查询真实号接通率 | 查询真实号接通率 |
该文章对您有帮助吗？