文档

RedialCall - 重拨

更新时间:

重拨脱敏后的话单中的号码

调试

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

授权信息

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

请求参数

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

呼叫中心实例 ID。

abc
UserIdstring

座席用户 ID 信息。

samzhang@abc
DeviceIdstring

座席端提供的唯一 ID,用来表示一个座席工作台。

CCC-x.x.x.x-chrome102-bsdf911812c60f61e
Callerstring

主叫号码。

0109810****
Calleestring

被叫号码。

1318888****
TimeoutSecondsinteger

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

30
Tagsstring

随路数据,不能超过 128 字节,主要用于扩展需求,普通客户无需关心。

a=b
JobIdstring

话务 ID。用来重拨的上一通电话的话务 ID。

job-6581536084722****

返回参数

名称类型描述示例值
object
Codestring

状态码。返回 OK 代表请求成功,其他错误码详见错误码列表。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息

RequestIdstring

请求 ID。

BF268B34-09C2-43FD-BAC4-5D31EA63****
Paramsarray

响应参数列表。

string

响应参数。

skillGroupId
Dataobject

数据。

ContextIdlong

上下文 ID,严格有序递增。

123456789
CallContextobject

话务上下文环境。

CallTypestring

呼叫类型, 最初发起呼叫时的类型。

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

呼叫中心实例 ID。

abc
JobIdstring

话务 ID。

job-6538214103685****
ChannelContextsobject []

话务通道列表。

ReleaseInitiatorstring

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

139xxxx0501
ChannelStatestring

话务通道的状态。

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

话务通道的被叫方。

8001****
UserIdstring

座席用户 ID 信息。

samzhang@abc
ChannelFlagsstring

话务通道标志。

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

状态数据上次变更时间戳。

1609138903315
ReleaseReasonstring

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

486:USER_BUSY
CallTypestring

话务通道的通话类型。

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

话务 ID。

job-6573574060089****
ChannelIdstring

话务通道 ID。

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

话务通道的主叫方。

1318888****
UserExtensionstring

用户分机号。

8000****
UserContextobject

坐席上下文环境。

Extensionstring

用户分机号。

8000****
WorkModestring

工作模式。枚举值:

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

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

CCC-x.x.x.x-chrome102-bsdf911812c60f61e
JobIdstring

话务 ID。

job-6573574060089****
UserIdstring

座席用户 ID 信息。

samzhang@abc
BreakCodestring

小休状态码,分为系统定义和客户定义两种。

系统定义的小休码:

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

客户自定义状态码没有限制,客户可以根据业务需要自行定义。

Warm-up
InstanceIdstring

实例 ID。

abc
OutboundScenarioboolean

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

False
UserStatestring

座席状态。枚举值:

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

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

string

坐席签入的技能组 ID。

skillgroup1@abc

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "BF268B34-09C2-43FD-BAC4-5D31EA63****",
  "Params": [
    "skillGroupId"
  ],
  "Data": {
    "ContextId": 123456789,
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "abc",
      "JobId": "job-6538214103685****",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "139xxxx0501",
          "ChannelState": "CREATED",
          "Destination": "8001****",
          "UserId": "samzhang@abc",
          "ChannelFlags": "COACHING",
          "Timestamp": 1609138903315,
          "ReleaseReason": "486:USER_BUSY",
          "CallType": "OUTBOUND",
          "JobId": "job-6573574060089****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "Originator": "1318888****",
          "UserExtension": "8000****\n"
        }
      ]
    },
    "UserContext": {
      "Extension": "8000****",
      "WorkMode": "ON_SITE\n",
      "DeviceId": "CCC-x.x.x.x-chrome102-bsdf911812c60f61e\n",
      "JobId": "job-6573574060089****",
      "UserId": "samzhang@abc\n",
      "BreakCode": "Warm-up",
      "InstanceId": "abc",
      "OutboundScenario": true,
      "UserState": "READY",
      "SignedSkillGroupIdList": [
        "skillgroup1@abc"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400UserBusyThe user %s you called was busy. Please try again later.您呼叫的用户正忙,请稍后再试。
400InvalidOperation.ChannelStateThe operation is not allowed. Channel stats (%s) does not meet expectations (%s).-
400InvalidOperation.UserStateThe operation is not allowed. User state (%s) does not meet expectations (%s).非法操作,用户状态不符合预期。
404NotExists.UserIdThe user %s does not exist in instance %s.呼叫中心实例中不存在指定的用户。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.ExtensionNo available extension number exists.没有可分配的分机号。
500InternalService.CTIAn internal CTI service error occurred. %s内部CTI服务错误。

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

变更历史

变更时间变更内容概要操作
2023-10-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:500
  • 本页导读 (0)
文档反馈