本產品(
智能聯絡中心/2019-10-15
)的OpenAPI采用RPC簽名風格,簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK,開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求,可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜,需花費 5個工作日左右。因此建議加入我們的服務釘釘群(78410016550),在專家指導下進行簽名對接。在使用API前,您需要準備好身份賬號及訪問密鑰(AccessKey),才能有效通過客戶端工具(SDK、CLI等)訪問API。細節請參見獲取AccessKey。
通信智能引擎
API | 標題 | API概述 |
---|---|---|
LlmSmartCall | 基于大模型的智能外呼 | 基于大模型的智能外呼。 |
熱線監控數據
API | 標題 | API概述 |
---|---|---|
GetHotlineServiceStatistics | 獲取熱線監控下服務統計量 | 獲取熱線監控下服務統計量。支持實例、時間緯度、坐席、部門、技能組分組查詢。 |
GetSkillGroupAndAgentStatusSummary | 獲取熱線監控下技能組坐席匯總狀態量 | 獲取熱線監控下技能組坐席匯總狀態量。支持實例、時間區間、部門、技能組分組查詢。 |
GetDepartmentalLatitudeAgentStatus | 獲取熱線監控下部門緯度狀態量 | 獲取熱線監控下部門緯度狀態量。支持實例、時間區間、部門分組查詢。 |
GetSkillGroupLatitudeState | 獲取熱線下監控技能組緯度狀態量 | 獲取熱線下監控技能組緯度狀態量。支持實例、時間區間、部門、技能組分組查詢。 |
GetAgentBasisStatus | 獲取熱線監控下坐席緯度狀態量 | 獲取熱線監控下坐席緯度狀態量。支持實例、時間區間、坐席、部門分組查詢。 |
GetAgentStatistics | 獲取熱線監控下坐席緯度統計量 | 獲取熱線監控下坐席緯度統計量。支持實例、時間區間、坐席、部門分組查詢。 |
在線監控數據
API | 標題 | API概述 |
---|---|---|
GetOnlineServiceVolume | 獲取在線監控下在線服務量 | 獲取在線監控下在線服務量。支持實例、時間區間、坐席、部門、技能組分組查詢。 |
GetSeatInformation | 獲取在線監控下部門坐席服務能力數據 | 獲取在線監控下部門坐席服務能力數據。支持實例、時間區間、部門分組查詢。 |
GetSkillGroupServiceCapability | 獲取在線監控下技能組緯度服務能力數據 | 獲取在線監控下技能組緯度服務能力數據。支持實例、時間區間、部門、技能組分組查詢。 |
GetSkillGroupAgentStatusDetails | 獲取技能組服務狀態量 | 獲取技能組服務狀態量。支持實例、時間區間、部門、技能組分組查詢。 |
GetOnlineSeatInformation | 獲取在線監控下在線坐席信息數據 | 獲取在線監控下在線坐席信息數據。支持實例、時間區間、坐席、部門分組查詢。 |
GetQueueInformation | 獲取在線監控下技能組緯度隊列信息 | 獲取在線監控下技能組緯度隊列信息。支持實例、時間區間、部門、技能組分組查詢。 |
熱線報表數據
API | 標題 | API概述 |
---|---|---|
GetSkillGroupStatusTotal | 獲取熱線報表下技能組狀態總量 | 獲取熱線報表下技能組狀態總量。支持實例、時間區間、坐席、部門、技能組分組查詢。 |
GetAgentDetailReport | 獲取熱線報表下熱線坐席詳情匯總數據 | 獲取熱線報表下熱線坐席詳情匯總數據。支持實例、時間區間、坐席、部門分組查詢。 |
在線報表數據
API | 標題 | API概述 |
---|---|---|
GetSkillGroupServiceStatus | 獲取在線報表下技能組服務狀態量 | 獲取在線報表下技能組服務狀態量。 |
GetAgentServiceStatus | 獲取在線報表下坐席服務狀態量 | 獲取在線報表下坐席服務狀態量。支持實例、時間區間、坐席、部門分組查詢。 |
坐席管理
API | 標題 | API概述 |
---|---|---|
CreateAgent | 創建坐席 | 創建悉犀客服工作臺坐席賬號,并返回坐席ID。 |
DeleteAgent | 刪除坐席 | 根據實例ID及坐席賬號名稱,刪除悉犀客服工作臺坐席賬號。 |
UpdateAgent | 更新坐席數據 | 根據實例ID、坐席賬號名稱修改悉犀客服工作臺坐席信息。支持修改坐席對外顯示名稱、坐席所屬技能組。 |
GetAgent | 獲取坐席信息 | 根據實例ID、坐席賬號名稱查詢悉犀客服工作臺坐席信息,如坐席ID等。 |
ListAgentBySkillGroupId | 獲取技能組下坐席信息 | 根據AICCS實例ID、技能組ID查詢悉犀客服工作臺坐席列表。 |
GetHotlineAgentStatus | 獲取熱線坐席狀態 | 根據AICCS實例ID、坐席賬號名稱查詢悉犀客服工作臺熱線坐席狀態。 |
RemoveAgentFromSkillGroup | 從技能組移除坐席賬號 | 通過指定技能組及坐席ID,從技能組移除坐席賬號。 |
GetHotlineAgentDetail | 獲取熱線坐席詳情 | 根據實例ID、坐席賬號名稱獲取熱線坐席當前服務詳情。 |
技能組管理
API | 標題 | API概述 |
---|---|---|
CreateSkillGroup | 創建技能組 | 根據技能組名稱和渠道類型創建技能組。 |
UpdateSkillGroup | 修改技能組 | 根據AICCS實例ID、技能組ID更新悉犀客服工作臺技能組信息。支持更新技能組描述、技能組對外顯示名稱。 |
RemoveSkillGroup | 刪除技能組 | 根據AICCS實例ID、技能組ID刪除悉犀客服工作臺技能組。 |
QuerySkillGroups | 查詢技能組 | 根據實例ID查詢悉犀客服工作臺技能組列表。 |
ListSkillGroup | 查詢技能組 | 根據實例ID、技能組渠道類型查詢悉犀客服工作臺技能組。 |
GetDepGroupTreeData | 查詢技能組分組和技能組列表 | 根據AICCS實例ID、坐席ID查詢技能組分組和技能組列表。 |
部門管理
API | 標題 | API概述 |
---|---|---|
CreateDepartment | 創建部門信息 | 根據AICCS實例ID、部門名稱創建部門信息,創建成功后會返回部門ID。 |
GetAllDepartment | 獲取所有部門信息 | 根據AICCS實例ID獲取所有部門信息,可獲取部門ID、部門名稱。 |
DeleteDepartment | 刪除部門信息 | 根據AICCS實例ID、部門ID刪除部門信息。 |
UpdateDepartment | 更新部門信息 | 根據AICCS實例ID、部門ID更新部門名稱。 |
通道
API | 標題 | API概述 |
---|---|---|
GenerateWebSocketSign | 生成MessageBox通道簽名 | 根據AICCS實例ID和坐席賬號名稱,生成消息通道訪問簽名。 |
通話詳情
API | 標題 | API概述 |
---|---|---|
HotlineSessionQuery | 批量查詢通話詳情 | 根據實例ID查詢通話詳情。 |
GetRecordData | 獲取錄音文件 | 調用GetRecordData接口獲取錄音文件。 |
GetRecordUrl | 獲取語音雙呼錄音鏈接 | 調用GetRecordUrl接口獲取語音雙呼錄音鏈接。 |
DescribeRecordData | 獲取通話記錄 | 調用DescribeRecordData接口獲取通話信息。 |
數據統計
API | 標題 | API概述 |
---|---|---|
GetIndexCurrentValue | 獲取當前數據統計指標 | 獲取當前數據統計指標(實時數據),支持實例ID、部門、技能組分組查詢。 |
GetAgentIndexRealTime | 獲取熱線坐席實時數據詳情 | 根據實例、部門、技能組分組獲取坐席詳情實時數據(實時數據)。 |
GetHotlineAgentDetailReport | 獲取熱線坐席維度(T+1)數據詳情 | 獲取熱線坐席維度(T+1)數據詳情。支持實例、時間區間、部門、技能組分組查詢。 |
GetHotlineGroupDetailReport | 獲取熱線技能組維度T+1數據詳情 | 獲取熱線技能組維度(T+1)數據詳情。支持實例、時間區間、部門、技能組分組獲取。 |
會話數據
API | 標題 | API概述 |
---|---|---|
QueryTouchList | 查詢接觸數據 | 根據實例、接觸ID列表、會話ID列表等查詢接觸數據。 |
GetCustomerInfo | 獲取會員信息 | 調用GetCustomerInfo接口根據工作臺會員ID獲取會員詳情。 |
GetHotlineMessageLog | 獲取熱線消息記錄 | 調用GetHotlineMessageLog接口獲取熱線消息記錄。 |
GetHotlineCallAction | 查詢話務動作結果數據 | 調用GetHotlineCallAction接口查詢話務動作結果數據。 |
機器人外呼
API | 標題 | API概述 |
---|---|---|
RobotCall | 發起機器人外呼 | 發起機器人外呼。支持根據配置好的機器人ID,即話術ID,通過外呼主叫號碼呼叫被叫號碼,可選擇通話過程是否錄音等功能。 |
ListRobotCallDialog | 查詢對話記錄 | 查詢對話記錄。支持根據呼叫唯一ID和呼叫創建時間查詢,對話記錄包含對話內容角色、話術內容、節點類型、開始時間、意圖標簽。 |
ListAiccsRobot | 獲取話術列表 | 獲取話術列表。包含機器人類型、機器人名稱、機器人ID、所屬業務、行業信息。 |
ListRobotParams | 查詢機器人參數列表 | 根據機器人ID,即話術ID,查詢機器人參數列表。 |
GetCallSoundRecord | 獲取通話錄音文件 | 根據呼叫創建時間、呼叫唯一ID獲取通話錄音文件URL,根據URL獲取通話錄音文件。 |
ListRobotNode | 獲取機器人節點信息列表 | 根據機器人ID,即話術ID,獲取機器人節點信息列表。 |
機器人外呼任務
API | 標題 | API概述 |
---|---|---|
CreateTask | 創建任務 | 根據任務名稱、機器人ID、外呼主叫號碼等創建任務。 |
AttachTask | 追加明細 | 根據任務ID和呼叫字符,追加明細。 |
StartTask | 啟動任務 | 根據任務ID啟動任務。 |
StopTask | 暫停任務 | 根據任務ID暫停任務。 |
CancelTask | 取消任務 | 根據任務ID取消任務。 |
ListTask | 獲取任務列表 | 獲取任務列表。包含任務總數、任務信息。 |
ListTaskDetail | 獲取任務明細信息 | 根據任務ID獲取任務明細信息。 |
ListDialog | 查詢對話記錄 | 根據任務ID和被叫號碼,查詢對話記錄。 |
智能外呼任務
API | 標題 | API概述 |
---|---|---|
CreateAiOutboundTask | 創建智能外呼任務 | 創建智能外呼任務。支持創建時設置任務類型、任務名、外呼主叫號碼、被叫號碼重復策略等。 |
CreateAiOutboundTaskBatch | 創建智能外呼任務的任務批次 | 根據實例ID、任務ID創建智能外呼任務的任務批次,使得任務下的數據可以按批次查詢。 |
DeleteAiOutboundTask | 刪除智能外呼任務 | 根據實例ID、任務ID刪除智能外呼任務。刪除后,獲取外呼任務列表時無法獲取到該任務。 |
GetAiOutboundTaskBizData | 查詢本次呼叫關聯的業務信息 | 根據實例ID、會話ID查詢本次呼叫關聯的業務信息。 |
GetAiOutboundTaskExecDetail | 獲取任務執行詳情 | 根據實例ID、任務ID獲取任務執行詳情。 |
GetAiOutboundTaskDetail | 獲取外呼任務詳情 | 根據實例ID、任務ID獲取外呼任務詳情。 |
UpdateAiOutboundTask | 更新外呼任務 | 根據實例ID、任務ID更新外呼任務。 |
InsertAiOutboundPhoneNums | 導入外呼被叫號碼 | 根據實例ID、任務ID導入外呼被叫號碼。 |
GetAiOutboundTaskProgress | 獲取外呼任務進展 | 根據實例ID、任務ID獲取外呼任務進展。 |
StopAiOutboundTask | 暫停外呼任務 | 根據實例ID、任務ID暫停外呼任務。 |
TerminateAiOutboundTask | 終止外呼任務 | 根據實例ID、任務ID終止外呼任務。 |
GetAiOutboundTaskList | 獲取外呼任務列表 | 根據實例ID、任務類型獲取外呼任務列表。 |
StartAiOutboundTask | 啟動外呼任務 | 根據實例ID、任務ID啟動外呼任務。 |
號碼管理
API | 標題 | API概述 |
---|---|---|
AddHotlineNumber | 新增熱線號碼 | 調用AddHotlineNumber接口新增熱線號碼。 |
DeleteHotlineNumber | 刪除配置的熱線號碼 | 調用DeleteHotlineNumber接口刪除配置的熱線號碼。 |
ResetHotlineNumber | 重置熱線號碼 | 調用ResetHotlineNumber接口重置熱線號碼的呼入(IVR流程)、呼出(生效范圍)配置信息。 |
QueryHotlineNumber | 查詢熱線號碼配置列表 | 根據實例ID查詢熱線號碼配置列表,支持通過熱線號碼模糊查詢。 |
GetConfigNumList | 獲取熱線設置號碼列表 | 調用GetConfigNumList接口獲取熱線設置號碼列表。 |
話務管理
API | 標題 | API概述 |
---|---|---|
AnswerCall | 接聽來電 | 調用AnswerCall接聽來電。 |
FinishHotlineService | 結束熱線服務 | 根據實例ID、坐席賬號名稱結束熱線服務。 |
GetNumLocation | 獲取號碼歸屬地 | 根據實例ID、電話號碼獲取該號碼的歸屬地信息。 |
GetRtcToken | 獲取移動坐席Token | 調用GetRtcToken獲取移動坐席Token。 |
HangupCall | 掛斷電話 | 調用HangupCall執行坐席掛機操作。 |
ListHotlineRecord | 獲取熱線錄音列表 | 調用ListHotlineRecord根據熱線會話ID查詢熱線錄音列表。 |
ListOutboundPhoneNumber | 獲取外呼號碼信息 | 根據實例ID、坐席賬號名稱獲取指定坐席下的主叫外呼電話號碼。 |
MakeDoubleCall | 通過服務端SDK發起呼叫 | 調用MakeDoubleCall通過服務端SDK發起呼叫。 |
SendHotlineHeartBeat | 發送熱線心跳 | 根據實例ID、坐席賬號名稱、心跳簽名發送熱線心跳請求。 |
StartCall | 坐席發起外呼 | 根據實例ID、坐席賬號名稱、熱線外呼主叫號碼、被叫號碼發起外呼。 |
StartHotlineService | 開始熱線服務 | 根據實例ID、坐席賬號名稱進行熱線坐席簽入,開始熱線服務。 |
SuspendHotlineService | 暫停熱線服務 | 在熱線坐席小休時,暫停熱線服務。 |