RemoveSNSSmsReceiver

API Request

URLs

DELETE zstack/v1/sns/sms-endpoints/{endpointUuid}/receivers/{phoneNumber}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X DELETE http://localhost:8080/zstack/v1/sns/sms-endpoints/196b91815e983d1397cb336a4fc9d054/receivers/13333333333

Request Parameters

Name	Type	Location	Description	Starting Version
endpointUuid	String	url	The UUID of the SMS endpoint.	3.7.0
phoneNumber	String	url	Optional. The phone number to receive SMS messages.	3.7.0
phoneNumberList	List	body	Optional. The list of phone numbers to receive SMS messages.	5.1.8
deleteMode	String	body	Optional.	3.7.0
systemTags	List	body	Optional. The system tags.	3.7.0
userTags	List	body	Optional. The user tags.	3.7.0

API Response

When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,

{
	"error": {
		"code": "SYS.1001",
		"description": "A message or a operation timeout",
		"details": "Create VM on KVM timeout after 300s"
	}
}

SDK Sample

Java SDK

RemoveSNSSmsReceiverAction action = new RemoveSNSSmsReceiverAction();
action.endpointUuid = "196b91815e983d1397cb336a4fc9d054";
action.phoneNumber = "13333333333";
action.phoneNumberList = asList("13333333333");
action.deleteMode = "Permissive";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
RemoveSNSSmsReceiverAction.Result res = action.call();

Python SDK

RemoveSNSSmsReceiverAction action = RemoveSNSSmsReceiverAction()
action.endpointUuid = "196b91815e983d1397cb336a4fc9d054"
action.phoneNumber = "13333333333"
action.phoneNumberList = [13333333333]
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveSNSSmsReceiverAction.Result res = action.call()

PreviousAddSNSSmsReceiver NextQuerySNSSmsEndpoint