ValidateSNSUniversalSmsEndpoint

API Request

URLs

PUT zstack/v1/sns/application-endpoints/universal-sms/{uuid}/validate

Headers

Authorization: OAuth the-session-uuid

Body

{
  "validateSNSUniversalSmsEndpoint": {
    "testMsg": "test sms",
    "phoneNumbers": [
      "134567898765",
      "18654321234"
    ]
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"validateSNSUniversalSmsEndpoint":{"testMsg":"test sms","phoneNumbers":["134567898765","18654321234"]}}' http://localhost:8080/zstack/v1/sns/application-endpoints/universal-sms/b762d45d18943f16abac61b600874b09/validate

Request Parameters

Name	Type	Location	Description	Starting Version
testMsg	String	body (contained in the validateSNSUniversalSmsEndpoint structure).		5.1.8
uuid	String	url	The resource UUID.	5.1.8
phoneNumbers	List	body (contained in the validateSNSUniversalSmsEndpoint structure).		5.1.8
systemTags	List	body	Optional. The system tags.	5.1.8
userTags	List	body	Optional. The user tags.	5.1.8

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

ValidateSNSUniversalSmsEndpointAction action = new ValidateSNSUniversalSmsEndpointAction();
action.testMsg = "test sms";
action.uuid = "b762d45d18943f16abac61b600874b09";
action.phoneNumbers = asList("134567898765","18654321234");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ValidateSNSUniversalSmsEndpointAction.Result res = action.call();

Python SDK

ValidateSNSUniversalSmsEndpointAction action = ValidateSNSUniversalSmsEndpointAction()
action.testMsg = "test sms"
action.uuid = "b762d45d18943f16abac61b600874b09"
action.phoneNumbers = [134567898765, 18654321234]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
ValidateSNSUniversalSmsEndpointAction.Result res = action.call()

PreviousUpdateSNSUniversalSmsEndpoint NextQuerySNSUniversalSmsEndpoint