調用MakeCall發起呼叫,被叫可以是內部坐席,也可以是外部客戶 。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | ccc-test |
UserId | string | 否 | 發起外呼的坐席 ID,非必填,不填默認使用當前 RAM 賬號映射的坐席。 | agent@ccc-test |
DeviceId | string | 是 | 設備 ID,無意義,可以隨便填寫。 | device |
Caller | string | 否 | 主叫號碼,如果是內部呼叫,這此參數無效,如果是外部呼叫,此參數為當前坐席可用的外呼號碼,需要確保該號碼可外呼且坐席對該號碼有使用權,使用權通過兩種途徑獲得,一是將號碼綁定到當前坐席簽入的技能組上,二是將號碼設置為坐席的個人外呼號碼。 | 010989**** |
Callee | string | 是 | 被叫號碼,如果是內部呼叫,該字段填寫目標坐席的分機號,如果是外呼呼叫,填寫客戶的電話號碼。 | 1318888**** |
TimeoutSeconds | integer | 否 | 超時時間,呼叫在經過該參數指定的時間仍然未接通的情況下,則主動掛斷,取值范圍 30-300,單位秒。 | 30 |
Tags | string | 否 | 隨路數據,客戶無需關心。 | tags |
MaskedCallee | string | 否 | 脫敏后的被叫號碼,如果該字段不為空,表示需要對被叫號碼脫敏,脫敏規則由客戶自行定義,只需將脫敏后的被叫號碼填入即可,使用脫敏被叫會導致某些場景下看到的是脫敏后的被叫號碼,無法查看真實被叫號碼。 | 131****8888 |
MediaType | string | 否 | 媒體類型,默認是語音(AUDIO), 其他可選參數包括 VIDEO。 | AUDIO |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "無",
"RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
"Params": [
"無"
],
"Data": {
"ContextId": 123456,
"CallContext": {
"CallType": "OUTBOUND",
"InstanceId": "ccc-test",
"JobId": "job-6570007401392****",
"ChannelContexts": [
{
"ReleaseInitiator": "無",
"ChannelState": "NONE",
"Destination": "8001****",
"UserId": "agent@ccc-test",
"ChannelFlags": "MONITORING",
"Timestamp": 1609225718295,
"ReleaseReason": "無",
"CallType": "OUTBOUND",
"JobId": "job-6570007401392****",
"ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
"Originator": "1318888****",
"UserExtension": "8001****",
"MediaType": "Audio"
}
]
},
"UserContext": {
"Extension": "8001****",
"WorkMode": "ON_SITE",
"DeviceId": "ACC-YUNBS-1.0.10-****",
"JobId": "job-6570007401392****",
"UserId": "agent@ccc-test",
"BreakCode": "Warm-up",
"InstanceId": "ccc-test",
"OutboundScenario": false,
"UserState": "READY",
"SignedSkillGroupIdList": [
"skillgroup1@ccc-test"
]
}
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | UserBusy | The user %s you called was busy. Please try again later. | 您呼叫的用戶正忙,請稍后再試。 |
400 | InvalidOperation.ChannelState | The operation is not allowed. Channel stats (%s) does not meet expectations (%s). | - |
400 | InvalidOperation.UserState | The operation is not allowed. User state (%s) does not meet expectations (%s). | 非法操作,用戶狀態不符合預期。 |
404 | NotExists.UserId | The user %s does not exist in instance %s. | 呼叫中心實例中不存在指定的用戶。 |
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心實例不存在。 |
404 | NotExists.Extension | No available extension number exists. | 沒有可分配的分機號。 |
500 | InternalService.CTI | An internal CTI service error occurred. %s | 內部CTI服務錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-30 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-11 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-10-26 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |