调用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 错误码发生变更 | 查看变更详情 |