调用MakeCall发起呼叫_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用MakeCall发起呼叫，被叫可以是内部坐席，也可以是外部客户。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
UserId	string	否	发起外呼的坐席 ID，非必填，不填默认使用当前 RAM 账号映射的坐席。	agent@ccc-test
DeviceId	string	是	设备 ID，无意义，可以随便填写。	device
Caller	string	否	主叫号码，如果是内部呼叫，这此参数无效，如果是外部呼叫，此参数为当前坐席可用的外呼号码，需要确保该号码可外呼且坐席对该号码有使用权，使用权通过两种途径获得，一是将号码绑定到当前坐席签入的技能组上，二是将号码设置为坐席的个人外呼号码。	010989****
Callee	string	是	被叫号码，如果是内部呼叫，该字段填写目标坐席的分机号，如果是外呼呼叫，填写客户的电话号码。	1318888****
TimeoutSeconds	integer	否	超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，取值范围 30-300，单位秒。	30
Tags	string	否	随路数据，客户无需关心。	tags
MaskedCallee	string	否	脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义，只需将脱敏后的被叫号码填入即可，使用脱敏被叫会导致某些场景下看到的是脱敏后的被叫号码，无法查看真实被叫号码。	131****8888
MediaType	string	否	媒体类型，默认是语音(AUDIO), 其他可选参数包括 VIDEO。	AUDIO

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
Params	array	响应参数列表。
	string	响应参数。	无
Data	object	数据。
ContextId	long	系统自增 ID，客户无需关心。	123456
CallContext	object	话务上下文环境。
CallType	string	通话类型。枚举值： INBOUND：呼入。 BARGE：强插。 CONSULTANT：咨询。 CONFERENCE：会议。 MONITOR：监听。 INTERNAL：内部通话。 OUTBOUND：呼出。 INTERCEPT：强拆。 BACK2BACK：双呼。 PREDICTIVE：预测式外呼。 COACH：辅导。	OUTBOUND
InstanceId	string	实例 ID。	ccc-test
JobId	string	通话 ID。	job-6570007401392****
ChannelContexts	object []	话务通道列表。
ReleaseInitiator	string	话务通道的挂断方，表示该话务通道是谁首先发起的挂断。	无
ChannelState	string	话务通道的状态。枚举值： CREATED：已创建。 ANSWERED：已接通。 RELEASED：已挂断。 RETIRED：已失效。 EARLY_MEDIA：早媒体阶段。 NONE：初始状态。 RINGING：振铃中。	NONE
Destination	string	话务通道的被叫方。	8001****
UserId	string	话务通道关联的坐席 ID，如果是客户的话务通道，该字段为空。	agent@ccc-test
ChannelFlags	string	话务通道标志。枚举值： COACHING：辅导中。 MONITORING：监听中。 MONITORED：被监听。 COACHED：被辅导。 HOLD：保持。 MUTED：静音。	MONITORING
Timestamp	long	话务通道最近一次状态变化的时间戳，格式是 Unix 时间戳，单位毫秒。	1609225718295
ReleaseReason	string	话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 SIP 协议中定义的响应码，请客户参考 SIP 协议分析挂断原因。	无
CallType	string	话务通道的通话类型。枚举值： INBOUND：呼入。 BARGE：强插。 CONSULTANT：咨询。 CONFERENCE：会议。 MONITOR：监听。 INTERNAL：内部通话。 OUTBOUND：呼出。 INTERCEPT：强拆。 BACK2BACK：双呼。 PREDICTIVE：预测式外呼。 COACH：辅导。	OUTBOUND
JobId	string	通话 ID。	job-6570007401392****
ChannelId	string	话务通道 ID。	ch:user:1390501**->8032:1609138902226:job-653821410368**
Originator	string	话务通道的主叫方。	1318888****
UserExtension	string	话务通道关联的坐席的分机号。	8001****
MediaType	string	媒体类型，默认是语音(AUDIO), 其他可选参数包括 VIDEO。	Audio
UserContext	object	坐席上下文环境。
Extension	string	坐席分机号。	8001****
WorkMode	string	工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	ON_SITE
DeviceId	string	设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。	ACC-YUNBS-1.0.10-****
JobId	string	通话 ID。	job-6570007401392****
UserId	string	坐席 ID。	agent@ccc-test
BreakCode	string	小休状态码，分为系统定义的和客户定义的两种，系统定义的小休吗包括：Warm-up （坐席上线后置闲前的临时小休状态）、RingingTimeout（坐席振铃超时导致的小休）、RejectCall（坐席拒接导致的小休）。客户自定义状态码没有限制，客户可以根据业务需要自行定义。	Warm-up
InstanceId	string	实例 ID。	ccc-test
OutboundScenario	boolean	坐席是否处于仅外呼模式。	false
UserState	string	座席状态。枚举值： READY：空闲。 WORKING：话后处理中。 DIALING：拨号中。 BREAK：小休。 OFFLINE：离线。 TALKING：通话中。 RINGING：振铃中。	READY
SignedSkillGroupIdList	array	坐席签入的技能组 ID 列表。
	string	技能组 ID。	skillgroup1@ccc-test

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
  "Params": [
    "无"
  ],
  "Data": {
    "ContextId": 123456,
    "CallContext": {
      "CallType": "OUTBOUND",
      "InstanceId": "ccc-test",
      "JobId": "job-6570007401392****",
      "ChannelContexts": [
        {
          "ReleaseInitiator": "无",
          "ChannelState": "NONE",
          "Destination": "8001****",
          "UserId": "agent@ccc-test",
          "ChannelFlags": "MONITORING",
          "Timestamp": 1609225718295,
          "ReleaseReason": "无",
          "CallType": "OUTBOUND",
          "JobId": "job-6570007401392****",
          "ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
          "Originator": "1318888****",
          "UserExtension": "8001****",
          "MediaType": "Audio"
        }
      ]
    },
    "UserContext": {
      "Extension": "8001****",
      "WorkMode": "ON_SITE",
      "DeviceId": "ACC-YUNBS-1.0.10-****",
      "JobId": "job-6570007401392****",
      "UserId": "agent@ccc-test",
      "BreakCode": "Warm-up",
      "InstanceId": "ccc-test",
      "OutboundScenario": false,
      "UserState": "READY",
      "SignedSkillGroupIdList": [
        "skillgroup1@ccc-test"
      ]
    }
  }
}

错误码

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

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

变更历史

变更时间

变更内容概要

操作

2024-01-11

OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：500
入参	OpenAPI 入参发生变更。
	新增入参：MediaType
出参	OpenAPI 返回结构发生变更。

2023-10-26

OpenAPI 错误码发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：404
	删除错误码：500