UpdateSubscription-阿里云帮助中心

Use the UpdateSubscription operation to configure message subscriptions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Cloud Contact Center instance.	ccc-test
AliyunUid	integer	No	Leave blank.	无
ProducerId	string	No	For Message Queue (MQ), enter the Group ID. For webhook, enter PID_Webhook.	GID_xxx
DefaultTopic	string	No	For MQ, enter the topic name. For webhook, enter Topic_Webhook.	ccc-event
AccessPoint	string	Yes	The endpoint for MQ. The service endpoint for webhook.	rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080
EventSubscriptionsJson	string	Yes	The message subscription checklist.	[{"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	No	The message push type. rocketmq4 rocketmq5 webhook	rocketmq5
Username	string	No	The MQ username. Specify this only when MqType is rocketmq5.	username
Password	string	No	The MQ password. Specify this only when MqType is rocketmq5.	password
MqInstanceId	string	No	The MQ instance ID. Specify this only when MqType is rocketmq4 or rocketmq5.	rmq-cn-****

Response elements

Element	Type	Description	Example
	object
Code	string	The response code.	OK
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The response message.	无
RequestId	string	The request ID.	03C67DAD-EB26-41D8-949D-9B0C470FB716
Params	array	The list of invalid parameters.
	string	An invalid parameter.	无
Data	object	Data.
InstanceId	string	The instance ID.	ccc-test
ProducerId	string	For MQ, enter the Group ID. For webhook, enter PID_Webhook.	GID_xxx
Topic	string	For MQ, enter the topic name. For webhook, enter Topic_Webhook.	ccc-event
AccessPoint	string	The endpoint for MQ. The service endpoint for webhook.	rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080
Username	string	The MQ username. Specify this only when MqType is rocketmq5.	username
MqType	string	The message push type. rocketmq4 rocketmq5 webhook	rocketmq5
MqInstanceId	string	The MQ instance ID. Specify this only when MqType is rocketmq4 or rocketmq5.	rmq-cn-****
EventList	array<object>	The event checklist.
	object	An event.
Name	string	The event name.	Dialing
Disabled	boolean	Indicates whether the push is disabled.	true
Topic	string	The event topic.	无

Examples

Success response

JSON format

{
  "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": "无"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	Parameter.Blank	The parameter %s must not be null or empty.
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.
404	NotExists.InstanceId	The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.