文档

StartConference - 发起会议

更新时间:

调用StartConference发起一个会议。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
UserIdstring

发起会议的坐席 ID,非必填,不填则默认使用当前 RAM 账户映射的坐席。

agent@ccc-test
ParticipantListJsonstring

参会方列表,格式为 JSON 数组的字符串,数组元素是参会方,如果是内呼坐席,参会方是目标的坐席分机号,如果是外呼客户,参会方是客户号码。

["8045****","1317511****"]
TimeoutSecondsinteger

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

30
Tagsstring

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

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

FDD327D1-AB8A-596B-883F-F63582A73F1D
Paramsarray

响应参数列表。

string

响应参数。

Dataobject

数据。

CallContextobject

话务上下文环境。

CallTypestring

通话类型。

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

实例 ID。

ccc-test
JobIdstring

通话 ID。

job-6538214103685****
ChannelContextsobject []

话务通道列表。

ReleaseInitiatorstring

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

1390501****
ChannelStatestring

话务通道的状态。

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

话务通道的被叫方。

8001****
UserIdstring

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

agent@ccc-test
ChannelFlagsstring

话务通道标志。

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

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

1609138903315
ReleaseReasonstring

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

404 - No destination
CallTypestring

话务通道的通话类型。

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

通话 ID。

job-6573574060089****
ChannelIdstring

话务通道 ID。

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

话务通道的主叫方。

1318888****
UserExtensionstring

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

8032****
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 时间戳,单位毫秒。

1609136956378
BreakCodestring

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

Warm-up
InstanceIdstring

实例 ID。

1609136956378
OutboundScenarioboolean

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

false
DeviceStatestring

设备状态。

枚举值:
  • UNREGISTERED未注册
  • ONLINE在线
  • OFFLINE离线
false
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": "FDD327D1-AB8A-596B-883F-F63582A73F1D",
  "Params": [
    "无"
  ],
  "Data": {
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6538214103685****",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "1390501****",
          "ChannelState": "ANSWERED",
          "Destination": "8001****",
          "UserId": "agent@ccc-test\n",
          "ChannelFlags": "MONITORING",
          "Timestamp": 1609138903315,
          "ReleaseReason": "404 - No destination",
          "CallType": "OUTBOUND",
          "JobId": "job-6573574060089****",
          "ChannelId": "ch:user:131888****->8001****:1609225718294:job-65700074013925376",
          "Originator": "1318888****",
          "UserExtension": "8032****\n"
        }
      ]
    },
    "UserContext": {
      "Extension": "8032****",
      "Heartbeat": 1609136956378,
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "UserId": "agent@ccc-test",
      "Reserved": 1609136956378,
      "BreakCode": "Warm-up\n",
      "InstanceId": "1609136956378\n",
      "OutboundScenario": false,
      "DeviceState": "false",
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s must not be null or empty.该参数不能为null值。
400Parameter.EmptyThe parameter %s may not be null or empty.该参数不能为null值或为空字符串。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
404NotExists.NumberThe specified number %s does not exist in instance %s.呼叫中心实例中不存在指定的号码。
500InternalService.CTIAn internal CTI service error occurred. %s内部CTI服务错误。

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

变更历史

变更时间变更内容概要操作
暂无变更历史