验证通用短信接收端(ValidateSNSUniversalSmsEndpoint)

API请求

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: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

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

参数列表

名字	类型	位置	描述	起始版本
testMsg	String	body(包含在validateSNSUniversalSmsEndpoint结构中)		5.1.8
uuid	String	url	资源的UUID，唯一标示该资源	5.1.8
phoneNumbers	List	body(包含在validateSNSUniversalSmsEndpoint结构中)		5.1.8
systemTags (可选)	List	body	系统标签	5.1.8
userTags (可选)	List	body	用户标签	5.1.8

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

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

SDK示例

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()

上一篇更新通用短信接收端(UpdateSNSUniversalSmsEndpoint)下一篇查询通用短信接收端(QuerySNSUniversalSmsEndpoint)