本产品(
云呼叫中心/2020-07-01
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
权限
API | 标题 | API概述 |
---|---|---|
ListPrivilegesOfUser | 获取坐席的权限列表 | 调用ListPrivilegesOfUser获取当前用户拥有的权限。 |
ListRoles | 获取角色列表 | 调用ListRoles获取指定实例下的所有角色。 |
实例
API | 标题 | API概述 |
---|---|---|
CreateInstance | 创建实例 | 调用CreateInstance创建一个云呼叫中心实例。 |
GetInstance | 获取实例 | 调用GetInstance获取指定实例ID所对应的云呼叫中心实例的详细信息。 |
ListInstances | 获取实例列表 | 调用ListInstances获取当前阿里云账号下的云呼叫中心实例列表。 |
ListInstancesOfUser | 获取用户所属的实例列表 | 调用ListInstancesOfUser获取用户所属的云呼叫中心实例列表。 |
ModifyInstance | 修改实例 | 调用ModifyInstance修改云呼叫中心实例。 |
号码
API | 标题 | API概述 |
---|---|---|
AddPersonalNumbersToUser | 添加多个号码到坐席 | 调用AddPersonalNumbersToUser添加一个或多个个人外呼号码到指定实例下的指定坐席。 |
AddPhoneNumbers | 添加号码 | 调用AddPhoneNumbers添加一个或多个号码到指定实例下。 |
AddPhoneNumberToSkillGroups | 添加号码到多个技能组 | 调用AddPhoneNumberToSkillGroups将号码关联到指定实例下的一个或多个技能组。 |
ListOutboundNumbersOfUser | 获取坐席的外呼号码列表 | 调用ListOutboundNumbersOfUser获取指定实例下指定坐席的可外呼号码。 |
ListPersonalNumbersOfUser | 获取坐席的个人号码列表 | 调用ListPersonalNumbersOfUser获取指定实例下指定坐席的个人外呼号码列表,也可通过该接口反查可添加为坐席个人外呼号码的号码列表。 |
ListPhoneNumbers | 获取号码列表 | 调用ListPhoneNumbers获取指定实例下的号码列表。 |
ListPhoneNumbersOfSkillGroup | 获取技能组的号码列表 | 调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表,也可以通过该接口反查未关联但可关联到该技能组的号码。 |
ListUnassignedNumbers | 获取未分配号码列表 | 调用ListUnassignedNumbers获取阿里云主账号下未分配到实例的号码列表。 |
ModifyPhoneNumber | 修改号码 | 调用ModifyPhoneNumber修改指定实例下指定号码的信息,主要是修改号码用途和绑定的联系流ID。 |
ImportCorpNumbers | 导入自有线路号码 | 导入自有线路号码,首次导入前,需联系云呼叫中心-售后技术支持进行加白。 |
RemovePersonalNumbersFromUser | 删除坐席关联的多个号码 | 调用RemovePersonalNumbersFromUser删除指定实例下指定坐席的一个或多个个人外呼号码。 |
RemovePhoneNumberFromSkillGroups | 删除多个技能组关联的号码 | 调用RemovePhoneNumberFromSkillGroups删除指定实例下指定号码关联的一个或多个技能组与该号码的绑定关系,删除的是号码与技能组的绑定关系,并不是真实号码。 |
RemovePhoneNumbers | 删除号码 | 调用RemovePhoneNumbers删除指定实例下的一个或多个号码。并非真实删除某个号码,而是将这个号码与实例进行解绑,包括号码关联的技能组、联系流、坐席等,都将随之解绑。 |
RemovePhoneNumbersFromSkillGroup | 删除技能组关联的多个号码 | 调用RemovePhoneNumbersFromSkillGroup删除指定实例下指定技能组关联的一个或多个号码与该技能组的关联关系。 |
IVR
API | 标题 | API概述 |
---|---|---|
CreateContactFlow | 创建联系流 | 创建一个IVR流程。 |
ListContactFlows | 获取联系流列表 | 调用ListContactFlows获取指定实例下的IVR联系流列表。 |
GetContactFlow | 获取指定联系流 | 获取指定联系流。 |
StartEditContactFlow | 创建联系流草稿 | 发起编辑联系流,生成联系流草稿。 |
CommitContactFlow | 提交联系流 | 提交联系流。 |
PublishContactFlow | 发布联系流 | 发布联系流。 |
DiscardEditingContactFlow | 撤销联系流编辑 | 撤销联系流编辑,丢弃对应草稿。 |
DeleteContactFlow | 删除联系流 | 删除指定联系流。 |
技能组
API | 标题 | API概述 |
---|---|---|
AddNumbersToSkillGroup | 添加多个号码到技能组 | 调用AddNumbersToSkillGroup添加一个或多个号码到同一个技能组下。 |
AddUsersToSkillGroup | 添加多个坐席到技能组 | 调用AddUsersToSkillGroup添加一个或多个坐席到同一个技能组。 |
CreateSkillGroup | 创建技能组 | 调用CreateSkillGroup在指定实例下创建一个技能组。 |
DeleteSkillGroup | 删除技能组 | 调用DeleteSkillGroup删除指定实例下指定技能组ID对应的技能组。 |
GetSkillGroup | 获取技能组 | 调用GetSkillGroup获取指定实例下指定技能组ID对应的技能组的信息。 |
ListBriefSkillGroups | 获取技能组概要列表 | 调用ListBriefSkillGroups获取指定实例下的技能组概要信息列表。 |
ListSkillGroups | 获取技能组列表 | 调用ListSkillGroups获取指定实例下的技能组列表。 |
ListSkillLevelsOfUser | 获取坐席的技能组等级列表 | 获取指定实例下指定坐席关联的技能组的技能等级列表,也可以使用该接口查询坐席可关联但未关联的技能组列表。 |
ModifySkillGroup | 修改技能组 | 调用ModifySkillGroup修改指定实例下指定技能组ID对应的技能组的信息,主要是修改技能组展示名和技能组的描述信息。 |
ModifySkillLevelsOfUser | 修改坐席的多个技能等级 | 修改指定实例下指定坐席的一个或多个技能组下的技能等级。 |
RemoveSkillGroupsFromUser | 删除坐席关联的多个技能组 | 调用RemoveSkillGroupsFromUser删除指定实例下指定坐席关联的一个或多个技能组与该坐席之间的关联关系。 |
坐席
API | 标题 | API概述 |
---|---|---|
AddSkillGroupsToUser | 添加多个技能组到坐席 | 调用AddSkillGroupsToUser添加一个或多个技能组到指定实例下的指定坐席。 |
AssignUsers | 导入多个坐席 | 调用AssignUsers将一个或多个RAM账户导入到指定实例中,成功导入后,RAM账户将以坐席的形式存在于实例中。 |
ChangeWorkMode | 改变坐席工作模式 | 调用ChangeWorkMode改变坐席的工作模式。 |
CreateUser | 创建坐席 | 调用CreateUser在指定实例下创建一个新的坐席。 |
GetUser | 获取坐席 | 调用GetUser获取指定实例下指定坐席ID对应的坐席信息。 |
ImportAdmins | 导入多个管理员 | 调用ImportAdmins导入一个或多个管理员到指定实例下,调用者需要拥有AliyunCCCFullAccess的权限,可以在RAM控制台进行授权。 |
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概述 |
---|---|---|
AnswerCall | 接听通话 | 调用AnswerCall接听指定实例下指定通话ID对应的通话。 |
BargeInCall | 强插通话 | 调用BargeInCall强行插入指定实例下指定通话ID对应的正在通话中的通话,强插成功后,通话将由原来的双方通话变成三人会议。 |
BlindTransfer | 直接转接通话 | 直接转接通话到其他坐席或某个技能组队列或外部号码,直接转接也叫盲转或单步转。 |
CancelAttendedTransfer | 取消咨询转移 | 调用CancelAttendedTransfer取消咨询转接,在发起咨询转接后,完成咨询转接前,均可调用该接口取消咨询转接,即使被转接方已经接通,也可以取消。 |
CoachCall | 辅导通话 | 调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席,辅导过程中被辅导坐席可以听到辅导者的声音,客户无法听到辅导者的声音。 |
CompleteAttendedTransfer | 完成咨询转接 | 调用CompleteAttendedTransfer完成咨询转。 |
EndConference | 退出会议 | 调用EndConference使指定坐席退出指定实例下指定通话ID对应的通话,该通话必须处于会议状态。 |
GetNumberLocation | 获取号码归属地信息 | 调用接口GetNumberLocation获取号码归属地信息。 |
HoldCall | 保持通话 | 调用HoldCall保持指定实例下指定通话ID对应的通话,通话被保持后,将暂时被挂起,此时被保持方会听到保持音乐。 |
InitiateAttendedTransfer | 发起咨询转接 | 咨询转接通话到其他坐席或某个技能组队列或外部号码,咨询转接也叫关注转或双步转。 |
InterceptCall | 强拆通话 | 调用InterceptCall强行拆开指定实例下指定通话ID对应的通话,通话必须处于监听状态,且由监听者发起强拆,强拆成功后,原本与客户通话的坐席会被挂断,发起强拆的坐席代替原坐席继续与客户通话。 |
LaunchAuthentication | 发起IVR核身 | 调用LaunchAuthentication使通话临时转入指定的IVR流程,调用此接口后,会在通话过程中进入IVR交互环节,通用用于核身操作。 |
LaunchSurvey | 发起满意度调查 | 调用LaunchSurvey发送满意度调查,该操作会导致挂机,如果是语音满意度,客户会在坐席挂机后进入IVR满意度调查流程,并在IVR流程中完成满意度采集。如果是短信满意度,则通话结束,客户收到满意度调查短信。 |
MakeCall | 发起呼叫 | 调用MakeCall发起呼叫,被叫可以是内部坐席,也可以是外部客户 。 |
MonitorCall | 监听通话 | 调用MonitorCall监听指定实例下指定通话ID对应的通话。通话必须处于坐席和客户双方正常接通状态,且发起监听的坐席有权限对被监听坐席进行监听。 |
MuteCall | 静音通话 | 调用MuteCall静音指定实例下指定通话ID对应的通话,只能由正在通话状态的坐席调用,且只能静音调用者自己,坐席静音后,客户将无法听见坐席的声音。 |
PickOutboundNumbers | 选择外呼号码 | 调用PickOutboundNumbers根据传入的被叫号码选择适合的主叫号码,选号逻辑由智能算法控制。 |
PollUserStatus | 轮询坐席状态 | 调用PollUserStatus轮询指定实例下指定坐席的坐席状态,一般由前端坐席工作台调用,用于同步坐席状态。 |
ReadyForService | 坐席就绪 | 调用ReadyForService使指定实例下的指定坐席就绪,就绪后坐席进入空闲状态。 |
RedialCall | 重拨 | 重拨脱敏后的话单中的号码 |
ReleaseCall | 挂断通话 | 调用ReleaseCall挂断指定实例下指定通话ID对应的通话,调用者必须是坐席,且正处于通话状态。 |
RetrieveCall | 取回通话 | 调用RetrieveCall取回指定实例下指定通话ID对应的通话,通话必须处于保持状态才可操作取回。 |
SaveRTCStatsV2 | 上报坐席端WebRTC统计信息 | 调用SaveRTCStatsV2上报坐席端WebRTC语音传输统计信息,普通客户无需关心该接口。 |
SaveTerminalLog | 保存坐席端日志信息 | 调用SaveTerminalLog上报坐席端日志信息,普通客户无需关心该接口。 |
SaveWebRtcInfo | 上报WebRTC状态信息 | 调用SaveWebRtcInfo上报座席端WebRTC的通话状态信息,包括通话质量监控数据等,用于后台统计和监控,客户无需关心该接口。 |
SaveWebRTCStats | 上报坐席端WebRTC统计信息 | 调用SaveWebRTCStats上报坐席端WebRTC语音传输统计信息,普通客户无需关心该接口。 |
SendDtmfSignaling | 发送按键信息 | 调用SendDtmfSignaling在通话过程中发送DTMF按键信息。 |
SignInGroup | 签入技能组 | 调用SignInGroup使坐席签入指定实例下的指定技能组,即坐席上线操作。 |
SignOutGroup | 签出技能组 | 调用SignOutGroup使坐席签出当前签入的技能组,即坐席下线操作。 |
StartBack2BackCall | 发起双呼 | 调用StartBack2BackCall发起双呼。 |
StartConference | 发起会议 | 调用StartConference发起一个会议。 |
StartPredictiveCall | 发起预测式外呼 | 调用StartPredictiveCall发起预测式外呼。 |
StartPrivacyCall | 发起隐私呼叫 | 发起隐私呼叫。 |
SwitchToConference | 转会议 | 调用SwitchToConference将指定实例下的指定通话的状态切换至三方会议,通常用于咨询转会议的场景。 |
TakeBreak | 小休 | 调用TakeBreak将指定实例下的指定坐席设置为小休状态。 |
UnmuteCall | 取消通话静音 | 调用UnmuteCall取消通话静音。 |
预测式外呼
API | 标题 | API概述 |
---|---|---|
AbortCampaign | 终止预测式外呼活动 | 调用AbortCampaign终止指定实例下指定活动ID对应的预测式外呼活动。 |
AddCases | 添加预测式外呼名单 | 调用AddCases添加外呼名单到指定实例下指定ID对应的预测式外呼活动。 |
AppendCases | 追加预测式外呼名单 | 添加外呼名单到指定实例下指定ID对应的预测式外呼活动。 |
CreateCampaign | 创建预测式外呼活动 | 调用CreateCampaign在指定实例下创建预测式外呼活动。 |
GetCampaign | 获取预测式外呼活动 | 调用GetCampaign获取指定实例下指定ID对应的预测式外呼活动。 |
GetCaseFileUploadUrl | 获取预测式外呼名单上传参数 | 调用GetCaseFileUploadUrl获取指定实例下预测式外呼名单文件的OSS上传参数,当使用文件导入的方式创建预测式外呼活动时,需要先调用此接口拿到文件上传参数,然后再调用CreateCampaign接口。 |
GetHistoricalCampaignReport | 获取预测式外呼活动历史数据报表 | 调用GetHistoricalCampaignReport接口获取指定实例下指定ID对应的预测式外呼活动的历史数据报表。 |
GetRealtimeCampaignStats | 获取预测式外呼活动实时坐席状态 | 调用GetRealtimeCampaignStats获取指定实例下指定ID对应的预测式外呼活动的实时坐席状态数据。 |
ListAttempts | 获取联系人拨打记录列表 | 调用ListAttempts获取指定实例下指定预测式外呼活动的联系人拨打记录列表。 |
ListCampaigns | 获取预测式外呼活动列表 | 调用ListCampaigns获取指定实例下的预测式外呼活动列表。 |
ListCampaignTrendingReport | 获取预测式外呼活动趋势报表 | 调用ListCampaignTrendingReport获取指定实例下指定ID对应的预测式外呼活动的趋势报表。 |
ListCases | 获取预测式外呼名单列表 | 调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。 |
PauseCampaign | 暂停预测式外呼活动 | 调用PauseCampaign暂停指定实例下指定ID对应的预测式外呼活动。 |
ResumeCampaign | 恢复预测式外呼活动 | 调用ResumeCampaign恢复指定实例下指定ID对应的预测式外呼活动。 |
UpdateCampaign | 修改外呼活动 | 修改外呼活动参数。 |
SubmitCampaign | 启动预测式外呼活动 | 调用SubmitCampaign启动指定实例下指定ID对应的预测式外呼活动。 |
报表
API | 标题 | API概述 |
---|---|---|
ListIntervalAgentSkillGroupReport | 获取分组坐席分段统计报表 | 获取指定实例下指定坐席的分段统计报表。 |
ListHistoricalAgentSkillGroupReport | 获取分组坐席历史数据报表 | 调用ListHistoricalAgentSkillGroupReport获取指定实例下的一个或多个坐席的历史分组数据报表。 |
GetCallDetailRecord | 获取通话详情 | 调用GetCallDetailRecord获取指定实例下指定通话ID对应的通话的详情。 |
GetConversationDetail | 获取对话详情 | 调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情,注意,实例及技能组需要开通质检推送才能获取到对话详情。 |
GetConversationDetail | 获取对话详情 | 调用GetConversationDetail获取指定实例下指定通话ID对应的通话的对话详情,注意,实例及技能组需要开通质检推送才能获取到对话详情。 |
GetHistoricalCallerReport | 获取历史来电报表 | 调用GetHistoricalCallerReport获取指定实例下指定来电号码的历史呼入报表。 |
GetHistoricalInstanceReport | 获取历史实例数据报表 | 调用GetHistoricalInstanceReport获取指定实例的历史数据报表。 |
GetInstanceTrendingReport | 获取实例趋势报表 | 调用GetInstanceTrendingReport获取指定实例的变化趋势报表。 |
GetRealtimeInstanceStates | 获取实时实例状态 | 调用GetRealtimeInstanceStates获取指定实例的实时状态。 |
ListAgentStateLogs | 获取坐席状态日志列表 | 调用ListAgentStateLogs获取指定实例下指定坐席的状态日志列表。注意本接口即将过期,请使用替代接口ListRealtimeAgentStates。 |
ListCallDetailRecords | 获取通话详情列表 | 调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新,建议优先使用ListCallDetailRecordsV2接口。 |
ListCallDetailRecordsV2 | 获取通话详情列表 | 获取指定实例下指定搜索条件过滤后的通话详情列表。 |
ListHistoricalAgentReport | 获取坐席历史数据报表 | 调用ListHistoricalAgentReport获取指定实例下的一个或多个坐席的历史数据报表。 |
ListHistoricalSkillGroupReport | 获取技能组历史数据报表 | 调用ListHistoricalSkillGroupReport获取指定实例下的一个或多个技能组的历史数据报表。 |
ListIntervalAgentReport | 获取坐席分段统计报表 | 调用ListIntervalAgentReport获取指定实例下指定坐席的分段统计报表。 |
ListIntervalInstanceReport | 获取实例分段统计报表 | 调用ListIntervalInstanceReport获取指定实例的分段统计报表。 |
ListIntervalSkillGroupReport | 获取技能组分段统计报表 | 调用ListIntervalSkillGroupReport获取指定实例下指定技能组的分段统计报表。 |
ListIvrTrackingDetails | 获取IVR轨迹详情列表 | 调用ListIvrTrackingDetails获取指定实例下指定通话的IVR轨迹详情。 |
ListRealtimeAgentStates | 获取实时坐席状态报表 | 调用ListRealtimeAgentStates获取指定实例下一个或多个指定坐席的实时状态数据报表。 |
ListRealtimeSkillGroupStates | 获取实时技能组状态报表 | 调用ListRealtimeSkillGroupStates获取指定实例下实时技能组状态报表。 |
ListRecentCallDetailRecords | 获取坐席最近通话记录列表 | 调用ListRecentCallDetailRecords获取指定实例下当前RAM账号映射的坐席的最近通话记录列表。 |
ListAgentStates | 获取坐席状态列表 | 调用ListAgentStates获取指定实例下按指定条件过滤后的坐席状态列表,该接口仅对特定用户开放,其他客户不建议调用。 |
ListAgentSummaryReportsSinceMidnight | 获取坐席概览数据列表 | 调用ListAgentSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的坐席历史数据报表,统计的是从当天0时开始,到当前时间为止的数据。该接口仅对特定用户开放,其他客户不建议调用。 |
ListLegacyAgentEventLogs | 获取遗留坐席事件日志列表 | 调用ListLegacyAgentEventLogs获取1.0遗留坐席事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。 |
ListLegacyAgentStatusLogs | 获取遗留坐席状态日志列表 | 调用ListLegacyAgentStatusLogs获取1.0遗留坐席状态日志列表,该接口仅对特定用户开放,其他客户不建议调用。 |
ListLegacyQueueEventLogs | 获取遗留队列事件日志列表 | 调用ListLegacyQueueEventLogs获取1.0遗留队列事件日志列表,该接口仅对特定用户开放,其他客户不建议调用。 |
ListSkillGroupStates | 获取技能组状态列表 | 调用ListSkillgroupStates获取指定实例下指定技能组的状态列表,该接口仅对特定用户开放,其他客户不建议调用。 |
ListSkillGroupSummaryReportsSinceMidnight | 获取技能组概览数据列表 | 调用ListSkillgroupSummaryReportsSinceMidnight获取指定实例下按指定条件过滤后的技能组历史数据报表,统计的时间范围是从当天0时开始,到当前时间结束。该接口仅对特定用户开放,其他客户不建议调用。 |
ListVoicemails | 获取语音信箱列表 | 调用ListVoicemails获取指定实例下语音信箱列表。 |
ListGroupChatMessages | 查询消息列表 | 查询Chat消息记录。 |
录音
API | 标题 | API概述 |
---|---|---|
GetMonoRecording | 获取单轨录音 | 调用GetMonoRecording获取指定实例下指定通话的单轨录音,单轨录音只有一个音轨,坐席侧和客户侧的录音合并到了同一个音轨上,格式为WAV。 |
GetMultiChannelRecording | 获取多轨录音 | 调用GetMultiChannelRecording获取指定实例下指定通话的多轨录音,多轨录音中坐席和客户的录音分布在不同的声道上,每次播放时只能单个声道播放,也就是只能听到其中一方的声音,格式为MKV。 |
GetVoicemailRecording | 获取语音信箱录音 | 调用GetVoicemailRecording获取指定实例下指定通话的语音信箱留言的录音,录音为单轨录音,格式为WAV。 |
GetEarlyMediaRecording | 获取通话早媒体音频 | 获取指定实例下的通话早媒体音频。 |
ListMultiChannelRecordings | 获取多通道录音列表 | 调用ListMultiChannelRecordings获取指定实例下指定通话的各通话方的多轨录音,通话中每一方都有一个话务通道,每个话务通道对应一个多轨录音,格式为MKV。 |
ListMonoRecordings | 获取单轨录音列表 | 调用ListMonoRecordings获取指定实例下指定通话的各通话方的单轨录音,通话中每一方都有一个话务通道,每个话务通道对应生成一个合轨录音,格式为WAV。 |
音频
API | 标题 | API概述 |
---|---|---|
CreateAudioFile | 创建音频文件 | 调用CreateAudioFile在指定实例下创建一个音频资源,创建好的音频资源可以在实例中应用,比如在IVR放音时可以选择创建好的音频文件。 |
DeleteAudioFile | 删除音频文件 | 调用DeleteAudioFile删除指定实例下指定音频资源ID对应的音频文件。 |
GetAudioFile | 获取音频文件 | 调用GetAudioFile获取指定实例下指定音频资源ID对应的音频文件信息。 |
GetAudioFileDownloadUrl | 获取音频文件下载链接 | 调用GetAudioFileDownloadUrl获取指定实例下指定音频资源的OSS下载链接。 |
GetAudioFileUploadParameters | 获取音频文件上传参数 | 调用GetAudioFileUploadParameters获取音频文件上传参数,创建音频文件时,需要先调用该接口拿到上传参数,然后再调用CreateAudioFile创建音频文件。该接口通常由云呼叫中心提供的公有云默认CRM系统调用,不建议集成客户调用该接口,因为需要在页面上操作上传文件,上传完成后,才能调用GetAudioFileUploadParameters接口。 |
ListAudioFiles | 获取音频文件列表 | 调用ListAudioFiles获取指定实例下的音频文件列表。 |
ModifyAudioFile | 修改音频文件 | 调用ModifyAudioFile修改指定实例下指定音频资源ID对应的音频文件。可以修改音频文件名称、音频文件展示名和音频文件在OSS中的Key。 |
配置
API | 标题 | API概述 |
---|---|---|
GetLoginDetails | 获取登录信息 | 调用GetLoginDetails获取坐席的登录信息,包括坐席基本信息、服务器地址信息、鉴权信息等,该接口只允许自己调用,管理员无权替他人调用。 |
GetTurnCredentials | 获取接入点凭证 | 调用GetTurnCredentials获取云呼叫中心前置接入点的连接凭证信息,主要包括鉴权需要用到的用户名和密码,通过前置接入点接入云呼叫中心可以有效提高网络质量和稳定性。 |
GetTurnServerList | 获取接入点列表 | 调用GetTurnServerList获取云呼叫中心的前置接入点列表,通过前置接入点接入云呼叫中心可以有效提高网络质量和网络稳定性。 |
ListConfigItems | 获取配置项列表 | 调用ListConfigItems获取指定实例下的配置信息。 |
UpdateConfigItems | 更新配置项 | 调用UpdateConfigItems添加或修改指定实例下的配置信息,例如:来电显示是否隐藏号码,呼入场景下是否允许坐席主动挂机等。 |
呼入控制
API | 标题 | API概述 |
---|---|---|
AddBlacklistCallTagging | 添加号码黑名标签 | 对指定号码添加黑名单标签,可结合IVR设置,防止其频繁呼入骚扰。 |
CreateCallTags | 创建多个号码标签 | 调用CreateCallTags在指定实例下创建多个号码标签。 |
CreateCustomCallTagging | 创建多个呼入号码标记 | 调用CreateCustomCallTagging在指定实例下创建一个或多个呼入号码标记。 |
DeleteCallTag | 删除号码标签 | 调用DeleteCallTag删除指定实例下的号码标签。 |
DeleteCustomCallTagging | 删除呼入号码标记 | 调用DeleteCustomCallTagging删除指定实例下指定号码对应的呼入号码标记。 |
ExportCustomCallTagging | 导出呼入号码标记 | 调用ExportCustomCallTagging导出指定实例下的全部呼入号码标记。 |
ImportCustomCallTagging | 导入呼入号码标记 | 调用ImportCustomCallTagging导入多个呼入号码标记到指定实例中。 |
ListBlacklistCallTaggings | 获取号码黑名单打标状态 | 批量查询指定号码黑名单打标状态。 |
ListCallTags | 获取号码标签列表 | 调用ListCallTags获取指定实例下的所有号码标签。 |
ListCustomCallTagging | 获取呼入号码标记列表 | 调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。 |
ModifyCustomCallTagging | 修改呼入号码标记 | 调用ModifyCustomCallTagging修改指定实例下指定号码对应的呼入号码标记的信息,可以修改呼入号码标记的描述和绑定的号码标签。 |
RemoveBlacklistCallTagging | 移除号码黑名单标签 | 移除指定号码的黑名单标签。 |
外呼控制
API | 标题 | API概述 |
---|---|---|
ExportDoNotCallNumbers | 导出禁止外呼号码 | 调用ExportDoNotCallNumbers导出指定实例下指定搜索条件过滤后的禁止外呼号码列表。 |
GetDoNotCallFileUploadParameters | 获取禁呼文件上传参数 | 调用GetDoNotCallFileUploadParameters获取禁呼文件的上传参数,当通过文件导入禁止外呼号码时,需要先调用此接口将禁呼号码文件上传到云呼叫中心的公共OSS空间,之后再调用ImportDoNotCallNumbers执行导入。 |
ImportDoNotCallNumbers | 导入禁止外呼号码 | 调用ImportDoNotCallNumbers向指定实例下导入一个或多个禁止外呼号码,导入方式包括手动录入和文件上传两种方式。 |
ListDoNotCallNumbers | 获取禁止外呼号码列表 | 获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。 |
RemoveDoNotCallNumbers | 删除禁止外呼号码 | 调用RemoveDoNotCallNumbers删除指定实例下的一个或多个禁止外呼号码配置项。 |
客户
API | 标题 | API概述 |
---|---|---|
DeleteSchemaProperty | 删除Scheme字段 | |
DisableSchemaProperty | 禁用Schema字段 | |
EnableSchemaProperty | 启用Schema字段 | |
GetSchema | 获取Schema | |
DeleteSchema | 删除Schema | |
GetDocumentUploadParameters | 获取导入Document上传地址 | |
UpdateSchemaProperty | 更新Schema字段 | |
SaveDocument | 保存Document | |
DeleteDocuments | 删除文档(批量) | |
DeleteDocument | 删除文档 | |
ListDocuments | 获取文档列表 | |
ImportDocuments | 导入文档 | |
CreateSchema | 创建Schema | |
AddSchemaProperty | 添加Schema字段 |
其他
API | 标题 | API概述 |
---|---|---|
GetUploadAudioDataParams | 获取离线质检音频相关参数 | 获取离线质检音频文件相关参数。一般情况下,如果客户在云联络中心中配置了质检功能,则需要离线质检的音频文件和相应的参数会自动传递给智能质检;只有当客户没有在云联络中心中配置质检功能,并且希望自己把联络中心的录音推送给质检时才需要调用此接口获取推送质检录音的相关参数。 |
RestoreArchivedRecordings | 解冻录音文件 | 解冻指定实例下的通话录音。 |
AnalyzeConversation | 分析对话内容 | 分析指定的文字通话内容,提取摘要类相关信息,比如标题,关键词、小结以及其他指定的信息。 |
GetTicketTemplate | 获取工单模板 | 使用GetTicketTemplate获取工单模板定义信息。 |
ListCategories | 获取类目 | 使用ListCategories获取类目信息。 |
CreateTicket | 创建工单 | 使用CreateTicket创建工单。 |
ListTicketTemplates | 获取工单模板列表 | 使用ListTickerTemplate获取工单模板列表。 |
AddTicketTask | 工单加签 | 使用AddTicketTask进行加签操作,添加处理人。 |
EnableTicketTemplate | 上线工单模板 | 使用EnableTicketTemplate上线工单模板,上线中状态的工单模板,可以用于创建工单。 |
DeleteTicket | 删除工单 | 通过DeleteTicket删除指定工单。 |
TransferTicketTask | 工单指派 | 使用TransferTicketTask指派工单给其他处理人处理。 |
ListTickets | 获取工单列表 | 使用ListTickets获取实例下工单列表。 |
ListTicketTasks | 获取工单节点信息 | |
WithdrawTicket | 撤回工单 | 使用WithdrawTicket撤回工单。 |
DisableTicketTemplate | 下线工单模板 | 使用DisableTicketTemplate进行工单模板的下线操作,下线状态的模板在新建工单时不能被选中。 |
RejectTicket | 退回工单 | 使用RejectTicket退回工单,退回的工单在创建人补充信息后可以重新提交。 |
DeleteTicketTemplate | 删除工单模板 | 使用DeleteTicketTemplate删除指定工单模板。 |
ResubmitTicket | 重新提交工单 | 使用ResubmitTicket接口对驳回/退回的工单重新提交。 |
GetTicketSummaryReport | 获取工单处理数据 | 使用GetTicketSummaryReport获取工单状态统计数据。 |
TerminateTicket | 关闭工单 | 使用TerminateTicket关闭工单。 |
ListCommonTicketFields | 获取工单字段定义 | 使用ListCommonTicketFields获取实例下定义的工单字段类型。 |
GetTicket | 获取工单 | 使用GetTicket获取指定工单信息。 |
UpdateTicket | 更新工单信息 | 使用UpdateTicket更新工单内容。 |
AcceptChat | 接受聊天 | 调用AcceptChat接受指定实例下指定话务ID对应的聊天。 |
GetVisitorLoginDetails | 获取访客登录信息 | 调用GeVisitortLoginDetails获取网络业务访客的登录信息,服务器地址信息、鉴权信息等。 |
RejectChat | 拒绝聊天 | 坐席通过RejectChat拒绝接受被分配的聊天。 |
StartChat | 发起聊天 | 调用StartChat发起聊天。 |
ReleaseChat | 结束聊天 | 通话ReleaseChat接口结束当前聊天。 |
ClaimChat | 认领聊天 | 调用ClaimChat认领指定实例下指定话务ID对应的聊天。 |
FinishTicketTask | 工单处理 | 使用FinishTicketTask对工单进行处理。 |