文档

CoachCall - 辅导通话

更新时间:

调用CoachCall辅导指定实例下指定通话ID对应的通话中的指定坐席,辅导过程中被辅导坐席可以听到辅导者的声音,客户无法听到辅导者的声音。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
UserIdstring

发起辅导的坐席 ID。

agent@ccc-test
DeviceIdstring

设备 ID,无意义,可以随便填写。

device
JobIdstring

通话 ID。

job-65382141036853491
CoachedUserIdstring

被辅导的坐席 ID。

coached-agent@ccc-test
TimeoutSecondsinteger

辅导超时时间,超过指定时间辅导没有建立,则取消辅导操作,此字段选填,默认 30,单位秒。

30

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

BA03159C-E808-4FF1-B27E-A61B6E888D7F
Paramsarray

响应参数列表。

string

响应参数。

Dataobject

数据。

CallContextobject

话务上下文环境。

CallTypestring

通话类型。

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

实例 ID。

ccc-test
JobIdstring

通话 ID。

job-6538214103685****
ChannelContextsobject []

话务通道列表。

Indexinteger

系统自增 ID,客户无需关心。

1
ReleaseInitiatorstring

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

1390501****
ChannelStatestring

话务通道的状态。

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

话务通道的被叫方。

1390501****
UserIdstring

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

agent@ccc-test
ChannelFlagsstring

话务通道标志。

枚举值:
  • COACHING辅导中
  • MONITORING监听中
  • MONITORED被监听
  • COACHED被辅导
  • HOLD保持
  • MUTED静音
COACHING
SkillGroupIdstring

话务通道关联的技能组 ID,呼入场景下,关联的技能组 ID 由 IVR 中转人工模块配置的技能组决定,呼出场景下,关联的技能组 ID 为座席签入的第一个技能组的 ID。

skillgroup@ccc-test
Timestamplong

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

1609138903315
ReleaseReasonstring

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

404 - No destination
CallTypestring

话务通道的通话类型。

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

通话 ID。

job-6538214103685****
ChannelIdstring

话务通道 ID。

ch:user:1390501****->8032****:1609138902226:job-653821410368****
UserExtensionstring

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

8032****
Originatorstring

话务通道的主叫方。

0830019****
UserContextobject

坐席上下文环境。

Extensionstring

坐席分机号。

8032****
Heartbeatlong

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

1609136956378
WorkModestring

工作模式。

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

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

ACC-YUNBS-1.0.10-****
UserIdstring

坐席 ID。

agent@ccc-test
Reservedlong

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

1609136956370
BreakCodestring

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

Warm-up
InstanceIdstring

实例 ID。

ccc-test
OutboundScenarioboolean

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

false
DeviceStatestring

SIP 话机设备的状态,如果未注册 SIP 话机,则状态为 UNREGISTERED(未注册),如过 SIP 话机注册过但是不在线,则状态为 OFFLINE(离线),如果 SIP 话机注册过并且在线则为 ONLINE(在线)。

UNREGISTERED
Mobilestring

坐席的个人电话号码。

1324730****
JobIdstring

通话 ID。

job-6538214103685****
UserStatestring

座席状态。

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

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

string

技能组 ID。

skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "COACH",
      "InstanceId": "ccc-test",
      "JobId": "job-6538214103685****",
      "ChannelContexts": [
        {
          "Index": 1,
          "ReleaseInitiator": "1390501****",
          "ChannelState": "ANSWERED",
          "Destination": "1390501****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "COACHING",
          "SkillGroupId": "skillgroup@ccc-test",
          "Timestamp": 1609138903315,
          "ReleaseReason": "404 - No destination",
          "CallType": "COACH",
          "JobId": "job-6538214103685****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "UserExtension": "8032****",
          "Originator": "0830019****"
        }
      ]
    },
    "UserContext": {
      "Extension": "8032****",
      "Heartbeat": 1609136956378,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609136956370,
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "DeviceState": "UNREGISTERED",
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidOperation.DeviceStateThe operation is not allowed. Device state (%s) does not meet expectations (%s).非法操作。 设备状态不符合预期。
400InvalidOperation.UserStateThe operation is not allowed. User state (%s) does not meet expectations (%s).非法操作,用户状态不符合预期。
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400UserBusyThe user %s you called was busy. Please try again later.您呼叫的用户正忙,请稍后再试。
403Permission.CommonYou have no permission to access. %s您无权进行访问。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.JobIdThe call %s does not exist.指定的通话信息不存在。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。

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

变更历史

变更时间变更内容概要操作
2024-01-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
出参OpenAPI 返回结构发生变更