UpdateSubscription - 配置消息订阅-云联络中心(Cloud Contact Center)-阿里云帮助中心

使用UpdateSubscription接口进行消息订阅配置。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	云联络中心实例 ID。	ccc-test
AliyunUid	integer	否	无需填写	无
ProducerId	string	否	MQ 方式，对应 GroupId。 Webhook 方式，填写 PID_Webhook。	GID_xxx
DefaultTopic	string	否	MQ 方式为 MQ 的 Topic。Webhook 方式填写 Topic_Webhook	ccc-event
AccessPoint	string	是	MQ 的接入地址。Webhook 的服务地址。	rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080
EventSubscriptionsJson	string	是	消息订阅清单。	[{"Name ":"StopConsultant ","Disabled ":true},{"Name ":"QueueingRerouted ","Disabled ":true},{"Name ":"IvrTracking ","Disabled ":true},{"Name ":"DualTrackRecordingReady ","Disabled ":true},{"Name ":"SatisfactionSurveyResponse ","Disabled ":true},{"Name ":"Dialing ","Disabled ":false},{"Name ":"Abandoned ","Disabled ":true},{"Name ":"QueueingCancelled ","Disabled ":true},{"Name ":"RecordingReady ","Disabled ":true},{"Name ":"StopCoach ","Disabled ":true},{"Name ":"Established ","Disabled ":true},{"Name ":"InitiateConsultant ","Disabled ":true},{"Name ":"Route2IVR ","Disabled ":false},{"Name ":"Retrieved ","Disabled ":true},{"Name ":"CampaignPaused ","Disabled ":true},{"Name ":"TextStream ","Disabled ":true},{"Name ":"AgentRelease ","Disabled ":true},{"Name ":"VoicemailReady ","Disabled ":true},{"Name ":"Released ","Disabled ":false},{"Name ":"CDRReady ","Disabled ":true},{"Name ":"CaseAttempted ","Disabled ":true},{"Name ":"AgentBreak ","Disabled ":true},{"Name ":"AgentRingingTimeout ","Disabled ":true},{"Name ":"AgentReady ","Disabled ":true},{"Name ":"CampaignResumed ","Disabled ":true},{"Name ":"AgentDialing ","Disabled ":true},{"Name ":"Ringing ","Disabled ":true},{"Name ":"StartConsultant ","Disabled ":false},{"Name ":"QueueingTimeout ","Disabled ":true},{"Name ":"AgentTalk ","Disabled ":true},{"Name ":"AgentRinging ","Disabled ":true},{"Name ":"StartMonitor ","Disabled ":true},{"Name ":"BlindTransfer ","Disabled ":true},{"Name ":"Intercept ","Disabled ":true},{"Name ":"RingingTimeout ","Disabled ":true},{"Name ":"StartConference ","Disabled ":true},{"Name ":"QueueingOverflow ","Disabled ":true},{"Name ":"BargeIn ","Disabled ":true},{"Name ":"StopConference ","Disabled ":true},{"Name ":"AgentCheckOut ","Disabled ":true},{"Name ":"CampaignSubmitted ","Disabled ":true},{"Name ":"AgentCheckIn ","Disabled ":true},{"Name ":"Enqueue ","Disabled ":false},{"Name ":"AttendedTransfer ","Disabled ":true},{"Name ":"StopMonitor ","Disabled ":true},{"Name ":"DispatchingFailure ","Disabled ":true},{"Name ":"SatisfactionSurveyOffer ","Disabled ":true},{"Name ":"CampaignCompleted ","Disabled ":true},{"Name ":"CampaignAborted ","Disabled ":true},{"Name ":"AssignAgent ","Disabled ":true},{"Name ":"Held ","Disabled ":true},{"Name ":"StartCoach ","Disabled ":true}]
MqType	string	否	消息推送类型。 rocketmq4 rocketmq5 webhook	rocketmq5
Username	string	否	MQ 用户名，只有当 MqType==rocketmq5 时，需要指定。	username
Password	string	否	MQ 密码，只有当 MqType==rocketmq5 时，需要指定。	password
MqInstanceId	string	否	MQ 实例，当 MqType==rocketmq4 或 MqType==rocketmq5 时，需要指定	rmq-cn-****

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	03C67DAD-EB26-41D8-949D-9B0C470FB716
Params	array	错误参数列表。
	string	错误参数。	无
Data	object	数据。
InstanceId	string	实例 ID。	ccc-test
ProducerId	string	MQ 方式，对应 GroupId。 Webhook 方式，填写 PID_Webhook。	GID_xxx
Topic	string	MQ 方式为 MQ 的 Topic。Webhook 方式填写 Topic_Webhook	ccc-event
AccessPoint	string	MQ 的接入地址。Webhook 的服务地址。	rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080
Username	string	MQ 用户名，只有当 MqType==rocketmq5 时，需要指定。	username
MqType	string	消息推送类型。 rocketmq4 rocketmq5 webhook	rocketmq5
MqInstanceId	string	MQ 实例，当 MqType==rocketmq4 或 MqType==rocketmq5 时，需要指定	rmq-cn-****
EventList	array<object>	消息事件清单。
	object	消息事件。
Name	string	事件名称。	Dialing
Disabled	boolean	是否推送。	true
Topic	string	事件主题。	无

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "03C67DAD-EB26-41D8-949D-9B0C470FB716",
  "Params": [
    "无"
  ],
  "Data": {
    "InstanceId": "ccc-test",
    "ProducerId": "GID_xxx",
    "Topic": "ccc-event",
    "AccessPoint": "rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080",
    "Username": "username",
    "MqType": "rocketmq5",
    "MqInstanceId": "rmq-cn-****",
    "EventList": [
      {
        "Name": "Dialing",
        "Disabled": true,
        "Topic": "无"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	Parameter.Blank	The parameter %s must not be null or empty.	该参数不能为null值。
400	Parameter.Enumeration	The parameter %s must be one of the value of enumeration %s.	该参数必须为系统限定的枚举值之一。
400	Parameter.Empty	The parameter %s may not be null or empty.	该参数不能为null值或为空字符串。
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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

变更历史

更多信息，参考变更详情。