首页 云呼叫中心 API参考 API目录 话务 StartConference - 发起会议

StartConference - 发起会议

调用StartConference发起一个会议。

调试

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

调试

授权信息

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

请求参数

名称 类型 必填 描述 示例值
InstanceId string

实例ID。

ccc-test
UserId string

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

agent@ccc-test
ParticipantListJson string

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

["8045****","1317511****"]
TimeoutSeconds integer

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

30
Tags string

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

返回参数

名称 类型 描述 示例值
object
Code string

响应码。

OK
HttpStatusCode integer

HTTP状态码。

200
Message string

响应信息。

RequestId string

请求ID。

FDD327D1-AB8A-596B-883F-F63582A73F1D
Params array

响应参数列表。

string

响应参数。

Data object

数据。

CallContext object

话务上下文环境。

CallType string

通话类型。

OUTBOUND
InstanceId string

实例ID。

ccc-test
JobId string

通话ID。

job-6538214103685****
ChannelContexts array

话务通道列表。

object

话务通道。

ReleaseInitiator string

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

1390501****
ChannelState string

话务通道的状态。

ANSWERED
Destination string

话务通道的被叫方。

8001****
UserId string

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

agent@ccc-test
ChannelFlags string

话务通道标志。

MONITORING
Timestamp long

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

1609138903315
ReleaseReason string

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

404 - No destination
CallType string

话务通道的通话类型。

OUTBOUND
JobId string

通话ID。

job-6573574060089****
ChannelId string

话务通道ID。

ch:user:131888****->8001****:1609225718294:job-65700074013925376
Originator string

话务通道的主叫方。

1318888****
UserExtension string

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

8032****
UserContext object

坐席上下文环境。

Extension string

坐席分机号。

8032****
Heartbeat long

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

1609136956378
WorkMode string

工作模式。

ON_SITE
DeviceId string

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

ACC-YUNBS-1.0.10-****
UserId string

坐席ID。

agent@ccc-test
Reserved long

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

1609136956378
BreakCode string

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

Warm-up
InstanceId string

实例ID。

1609136956378
OutboundScenario boolean

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

false
DeviceState string

设备状态。

false
Mobile string

坐席的个人电话号码。

1324730****
JobId string

通话ID。

job-6538214103685****
UserState string

座席状态。

TALKING
SignedSkillGroupIdList array

坐席签入的技能组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": true,
      "DeviceState": "false",
      "Mobile": "1324730****",
      "JobId": "job-6538214103685****",
      "UserState": "TALKING",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

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

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

阿里云首页 云呼叫中心 相关技术圈