API概览

本产品(云呼叫中心/2020-07-01)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行对接,或提交工单反馈给我们。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

坐席

API标题API概述
AddSkillGroupsToUser添加多个技能组到坐席调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。
AssignUsers导入多个坐席调用AssignUsers将一个或多个RAM账户导入到指定实例中,成功导入后,RAM账户将以坐席的形式存在于实例中。
ChangeWorkMode改变坐席工作模式调用ChangeWorkMode改变坐席的工作模式。
CreateUser创建坐席调用CreateUser在指定实例下创建一个新的坐席。
GetUser获取坐席调用GetUser获取指定实例下指定坐席ID对应的坐席信息。
ImportAdmins导入多个管理员调用ImportAdmins导入一个或多个管理员到指定实例下,调用者需要拥有AliyunCCCFullAccess的权限,可以在RAM控制台进行授权。
ListDevices获取设备列表调用ListDevices获取指定实例下指定坐席的设备列表。
ListRamUsers获取RAM用户列表调用ListRamUsers获取未导入指定实例下的RAM用户列表。
ListUserLevelsOfSkillGroup获取技能组的坐席等级列表调用ListUserLevelsOfSkillGroup获取指定实例下指定技能组下属的坐席技能等级列表,也可以调用该接口反差可关联但未关联指定技能组的坐席列表。
ListUsers获取坐席列表调用ListUsers获取指定实例下的坐席列表。
ModifyUser修改坐席调用ModifyUser修改指定实例下指定坐席的信息,可修改电话号码、工作模式、角色和工号。
ModifyUserLevelsOfSkillGroup修改技能组的多个坐席等级调用ModifyUserLevelsOfSkillGroup修改指定实例下指定技能组下属的一个或多个坐席的技能等级。
RegisterDevice注册设备调用RegisterDevice注册SIP设备到指定实例下的指定坐席, SIP设备可以是SIP话机或SIP软电话。
RegisterDevices注册多个设备调用RegisterDevices注册一个或多个SIP设备到指定实例下的指定坐席,SIP设备可以是SIP话机或SIP软电话。
RemoveUsers删除坐席调用RemoveUsers删除指定实例下的一个或多个坐席,该操作仅将RAM账户与实例解绑,然后将RAM账户映射的坐席从实例中删除,并不会删除RAM账户本身。
RemoveUsersFromSkillGroup删除技能组关联的多个坐席调用RemoveUsersFromSkillGroup删除指定实例下指定技能组关联的一个或多个坐席,该操作仅删除技能组与坐席之间的关联关系,并不会删除坐席。
ResetAgentState重置坐席状态调用ResetAgentState重置指定实例下指定坐席的坐席状态。
ResetUserPassword重置坐席密码调用ResetUserPassword重置指定实例下指定坐席的登录密码。实际上坐席并没有登录密码,修改的是坐席关联的RAM账户的登录密码,通常用于客服忘记自己的RAM账户登录密码的场景。
UnregisterDevice删除注册设备调用UnregisterDevice删除指定实例下指定坐席的设备注册记录,删除后将导致与坐席关联的SIP话机或SIP软电话不可用。

报表

API标题API概述
GetCallDetailRecord获取通话详情调用GetCallDetailRecord获取指定实例下指定通话ID对应的通话的详情。
GetConversationDetail获取对话详情调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情,注意,实例及技能组需要开通质检推送才能获取到对话详情。
GetConversationDetail获取对话详情调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情,注意,实例及技能组需要开通质检推送才能获取到对话详情。
GetHistoricalCallerReport获取历史来电报表调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。
GetHistoricalInstanceReport获取历史实例数据报表调用GetHistoricalInstanceReport获取指定实例的历史数据报表。
GetInstanceTrendingReport获取实例趋势报表调用GetInstanceTrendingReport获取指定实例的变化趋势报表。
GetMonoRecording获取单轨录音调用GetMonoRecording获取指定实例下指定通话的单轨录音,单轨录音只有一个音轨,坐席侧和客户侧的录音合并到了同一个音轨上,格式为WAV。
GetMultiChannelRecording获取多轨录音调用GetMultiChannelRecording获取指定实例下指定通话的多轨录音,多轨录音中坐席和客户的录音分布在不同的声道上,每次播放时只能单个声道播放,也就是只能听到其中一方的声音,格式为MKV。
GetRealtimeInstanceStates获取实时实例状态调用GetRealtimeInstanceStates获取指定实例的实时状态。
GetVoicemailRecording获取语音信箱录音调用GetVoicemailRecording获取指定实例下指定通话的语音信箱留言的录音,录音为单轨录音,格式为WAV。
ListAgentStateLogs获取坐席状态日志列表调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。
ListAgentStates获取坐席状态列表调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表,该接口仅对特定用户开放,其他客户不建议调用。
ListAgentSummaryReportsSinceMidnight获取坐席概览数据列表调用ListAgentSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的坐席历史数据报表,统计的是从当天0时开始,到当前时间为止的数据。该接口仅对特定用户开放,其他客户不建议调用。
ListCallDetailRecords获取通话详情列表调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。
ListHistoricalAgentReport获取坐席历史数据报表调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。
ListHistoricalSkillGroupReport获取技能组历史数据报表调用ListHistoricalSkillGroupReport获取指定实例下的一个或多个技能组的历史数据报表。
ListIntervalAgentReport获取坐席分段统计报表调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。
ListIntervalInstanceReport获取实例分段统计报表调用ListIntervalInstanceReport获取指定实例的分段统计报表。
ListIntervalSkillGroupReport获取技能组分段统计报表调用ListIntervalSkillGroupReport获取指定实例下指定技能组的分段统计报表。
ListIvrTrackingDetails获取IVR轨迹详情列表调用ListIvrTrackingDetails获取指定实例下指定通话的IVR轨迹详情。
ListLegacyAgentEventLogs获取遗留坐席事件日志列表调用ListLegacyAgentEventLogs获取1.0遗留坐席事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。
ListLegacyAgentStatusLogs获取遗留坐席状态日志列表调用ListLegacyAgentStatusLogs获取1.0遗留坐席状态日志列表,该接口仅对特定用户开放,其他客户不建议调用。
ListLegacyQueueEventLogs获取遗留队列事件日志列表调用ListLegacyQueueEventLogs获取1.0遗留队列事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。
ListMonoRecordings获取单轨录音列表调用ListMonoRecordings获取指定实例下指定通话的各通话方的单轨录音,通话中每一方都有一个话务通道,每个话务通道对应生成一个合轨录音,格式为WAV。
ListMultiChannelRecordings获取多通道录音列表调用ListMultiChannelRecordings获取指定实例下指定通话的各通话方的多轨录音,通话中每一方都有一个话务通道,每个话务通道对应一个多轨录音,格式为MKV。
ListRealtimeAgentStates获取实时坐席状态报表调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。
ListRealtimeSkillGroupStates获取实时技能组状态报表调用ListRealtimeSkillGroupStates获取指定实例下实时技能组状态报表。
ListRecentCallDetailRecords获取坐席最近通话记录列表调用ListRecentCallDetailRecords获取指定实例下当前RAM账号映射的坐席的最近通话记录列表。
ListSkillGroupStates获取技能组状态列表调用ListSkillgroupStates获取指定实例下指定技能组的状态列表,该接口仅对特定用户开放,其他客户不建议调用。
ListSkillGroupSummaryReportsSinceMidnight获取技能组概览数据列表调用ListSkillgroupSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的技能组历史数据报表,统计的时间范围是从当天0时开始,到当前时间结束。该接口仅对特定用户开放,其他客户不建议调用。

呼入控制

API标题API概述
CreateCallTags创建多个号码标签调用CreateCallTags在指定实例下创建多个号码标签。
CreateCustomCallTagging创建多个呼入号码标记调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。
DeleteCallTag删除号码标签调用DeleteCallTag删除指定实例下的号码标签。
DeleteCustomCallTagging删除呼入号码标记调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。
ExportCustomCallTagging导出呼入号码标记调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。
ImportCustomCallTagging导入呼入号码标记调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。
ListCallTags获取号码标签列表调用ListCallTags获取指定实例下的所有号码标签。
ListCustomCallTagging获取呼入号码标记列表调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。
ModifyCustomCallTagging修改呼入号码标记调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息,可以修改呼入号码标记的描述和绑定的号码标签。
阿里云首页 云呼叫中心 相关技术圈