首页 >云呼叫中心 >API参考 >API目录 >话务 >StartPredictiveCall - 发起预测式外呼

StartPredictiveCall - 发起预测式外呼

调用StartPredictiveCall发起预测式外呼。

接口说明

云呼叫中心除了支持客服从坐席工作台发起外呼外,还支持从自有业务系统后台发起外呼,待接通后转给坐席。以支持把云呼叫中心功能无缝嵌入您的业务流程。 比如,您的客户可以在您的微信公众号上,输入自己的号码,并点击咨询产品的按钮,由您的后台系统调用本接口,实现呼叫客户手机,接通后播放“我们收到您在公众号上对我们产品的咨询,现在给您转接顾问,请稍等”,并转给合适的客服接听通话。 相较于1.0的DialEX接口,用户使用该接口可以更加灵活的进行配置。除了可以自定义外呼转入的IVR外,还可以传入自定义的参数,在IVR中对参数进行语音播报,实现通知的场景。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

ccc-test
Callerstring

主叫号码,需要是实例下可用的外呼号码。

0109810****
Calleestring

被叫号码。

1312353****
TimeoutSecondsinteger

超时时间,呼叫在经过该参数指定的时间仍然未接通的情况下,则主动挂断,单位秒。

10
ContactFlowIdstring

IVR联系流ID,被叫接通后,通话将自动转入此IVR流程。

9774c36c-12fe-4e37-adce-89bc77ce****
Tagsstring

随路数据,主要用于扩展需求,普通用户无需关心。

ContactFlowVariablesstring

传入的联系流变量,格式为JSON数组的字符串,数组元素是一个键值对,Key为变量名,Value为变量值。在联系流ID对应的IVR的开始节点中新建同名的自定义参数,即可在IVR流程中使用该参数。

{"name":"王先生","time":"19点20分","address":"某某中心"}
MaskedCalleestring

脱敏后的被叫号码,如果该字段不为空,表示需要对被叫号码脱敏,脱敏规则由客户自行定义,只需将脱敏后的被叫号码填入即可,使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码,无法查看真实被叫号码。

1312353****
SkillGroupIdstring

技能组ID,非必填,如果该参数有值,则外呼号码仅从该参数指定的技能组的关联号码中选取。

skillgroup@ccc-test

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
Paramsarray

响应参数列表。

string

响应参数。

Dataobject

数据。

CallContextobject

话务上下文环境。

CallTypestring

通话类型。

OUTBOUND
枚举值:
- INBOUND: 呼入
- BARGE: 强插
- CONSULTANT: 咨询
- CONFERENCE: 会议
- MONITOR: 监听
- INTERNAL: 内部通话
- OUTBOUND: 呼出
- INTERCEPT: 强拆
- BACK2BACK: 双呼
- PREDICTIVE: 预测式外呼
- COACH: 辅导
InstanceIdstring

实例ID。

ccc-test
JobIdstring

通话ID。

job-6570007401392****
ChannelContextsarray

话务通道列表。

object

话务通道。

ReleaseInitiatorstring

话务通道的挂断方,表示该话务通道是谁首先发起的挂断。

ChannelStatestring

话务通道的状态。

NONE
枚举值:
- CREATED: 已创建
- ANSWERED: 已接通
- RELEASED: 已挂断
- RETIRED: 已失效
- EARLY_MEDIA: 早媒体阶段
- NONE: 初始状态
- RINGING: 振铃中
Destinationstring

话务通道的被叫方。

8001****
UserIdstring

话务通道关联的坐席ID,如果是客户的话务通道,该字段为空。

agent@ccc-test
ChannelFlagsstring

话务通道标志。

[]
枚举值:
- COACHING: 辅导中
- MONITORING: 监听中
- MONITORED: 被监听
- COACHED: 被辅导
- HOLD: 保持
- MUTED: 静音
TimestampLong

话务通道最近一次状态变化的时间戳,格式是Unix时间戳,单位毫秒。

1609225718295
ReleaseReasonstring

话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自SIP协议中定义的响应码,请客户参考SIP协议分析挂断原因。

CallTypestring

话务通道的通话类型。

OUTBOUND
枚举值:
- INBOUND: 呼入
- BARGE: 强插
- CONSULTANT: 咨询
- CONFERENCE: 会议
- MONITOR: 监听
- INTERNAL: 内部通话
- OUTBOUND: 呼出
- INTERCEPT: 强拆
- BACK2BACK: 双呼
- PREDICTIVE: 预测式外呼
- COACH: 辅导
JobIdstring

通话ID。

job-6570007401392****
ChannelIdstring

话务通道ID。

ch:user:131888****->8001****:1609225718294:job-6570007401392****
Originatorstring

话务通道的主叫方。

1318888****
UserExtensionstring

话务通道关联的坐席的分机号。

8001****
UserContextobject

坐席上下文环境。

Extensionstring

坐席分机号。

8001****
HeartbeatLong

上次收到坐席心跳的时间,格式为Unix时间戳,单位毫秒。

1609136956378
WorkModestring

工作模式。

ON_SITE
枚举值:
- ON_SITE: 场内模式
- OFF_SITE: 场外模式
- OFFICE_PHONE: 办公电话模式
DeviceIdstring

设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
UserIdstring

坐席ID。

agent@ccc-test
ReservedLong

坐席最近一次被预定的时间,被预定意味着马上将有来电分配给该坐席,格式为Unix时间戳,单位毫秒。

1609136956378
BreakCodestring

小休状态码,分为系统定义的和客户定义的两种,系统定义的小休吗包括:Warm-up (坐席上线后置闲前的临时小休状态)、RingingTimeout(坐席振铃超时导致的小休)、RejectCall(坐席拒接导致的小休)。客户自定义状态码没有限制,客户可以根据业务需要自行定义。

Warm-up
枚举值:
- RingingTimeout: 坐席振铃超时导致的小休
- RejectCall: 坐席拒接导致的小休
- Warm-up: 坐席上线后置闲前的临时小休状态
InstanceIdstring

实例ID。

ccc-test
OutboundScenarioboolean

坐席是否处于仅外呼模式。

false
DeviceStatestring

设备状态。

ONLINE
枚举值:
- UNREGISTERED: 未注册
- ONLINE: 在线
- OFFLINE: 离线
Mobilestring

坐席的个人电话号码。

1324730****
JobIdstring

通话ID。

job-6570007401392****
UserStatestring

座席状态。

READY
枚举值:
- READY: 空闲
- WORKING: 话后处理中
- DIALING: 拨号中
- BREAK: 小休
- OFFLINE: 离线
- TALKING: 通话中
- RINGING: 振铃中
SignedSkillGroupIdListarray

坐席签入的技能组ID列表。

string

技能组ID。

skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6570007401392****",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "无",
          "ChannelState": "NONE",
          "Destination": "8001****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "[]",
          "Timestamp": 1609225718295,
          "AssociatedData": "无",
          "ReleaseReason": "无",
          "CallType": "OUTBOUND",
          "JobId": "job-6570007401392****",
          "ChannelId": "ch:user:131888****->8001****:1609225718294:job-6570007401392****",
          "Originator": "1318888****",
          "UserExtension": "8001****"
        }
      ]
    },
    "UserContext": {
      "Extension": "8001****",
      "Heartbeat": 1609136956378,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609136956378,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": true,
      "DeviceState": "ONLINE",
      "Mobile": "1324730****",
      "JobId": "job-6570007401392****",
      "UserState": "READY",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

Http code错误码错误信息描述
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
404NotExists.NumberThe specified number %s does not exist in instance %s.呼叫中心实例中不存在指定的号码。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-11-29OpenAPI 错误码发生变更、 OpenAPI 入参发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:SkillGroupId
阿里云首页 云呼叫中心 相关技术圈