Remove SMS Receiver

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

Request

cURL

curl --request DELETE \
  --url '/v1/sns/sms-endpoints/{endpointUuid}/receivers/{phoneNumber}'

{
  "status": "ok",
  "method": "DELETE",
  "path": "/v1/sns/sms-endpoints/{endpointUuid}/receivers/{phoneNumber}"
}

Headers

Authorization: OAuth the-session-uuid

Curl Example

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/18812345678?deleteMode=Permissive

Parameter List

Name	Type	Location	Description	Starting Version
endpointUuid	String	url	SMS endpoint UUID	3.7.0
phoneNumber	String	url	SMS receiving phone number	3.7.0
deleteMode (Optional)	String	body		3.7.0
systemTags (Optional)	List	body	System tags	3.7.0
userTags (Optional)	List	body	User tags	3.7.0

API Response

On success, this API returns an empty JSON structure {}. On error, the returned JSON structure contains 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 Examples

Java SDK

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

Python SDK

RemoveSNSSmsReceiverAction action = RemoveSNSSmsReceiverAction()
action.endpointUuid = "196b91815e983d1397cb336a4fc9d054"
action.phoneNumber = "18812345678"
action.deleteMode = "Permissive"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
RemoveSNSSmsReceiverAction.Result res = action.call()