通过指定号码测试短信插件通知对象(ValidateSNSSmsPluginEndpoint)

API请求

URLs

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

Headers

Authorization: OAuth the-session-uuid

Body

{
  "validateSNSSmsPluginEndpoint": {
    "testMessage": "test message",
    "phoneNumbers": [
      "+86-18612345678"
    ]
  },
  "systemTags": [],
  "userTags": []
}

Note: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"validateSNSSmsPluginEndpoint":{"testMessage":"test message","phoneNumbers":["+86-18612345678"]}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/plugin/sms/d6973dc39d7437dd805b3a07b7f60975/validate

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	通知对象 UUID	5.5.38
phoneNumbers	List	body(包含在validateSNSSmsPluginEndpoint结构中)	1至200个互不重复的测试号码	5.5.38
testMessage	String	body(包含在validateSNSSmsPluginEndpoint结构中)	必填测试短信内容，最长1024字符	5.5.38
systemTags (可选)	List	body	系统标签	5.5.38
userTags (可选)	List	body	用户标签	5.5.38

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

ValidateSNSSmsPluginEndpointAction action = new ValidateSNSSmsPluginEndpointAction();
action.testMessage = "test message";
action.uuid = "d6973dc39d7437dd805b3a07b7f60975";
action.phoneNumbers = java.util.Arrays.asList("+86-18612345678");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
ValidateSNSSmsPluginEndpointAction.Result res = action.call();

Python SDK

action = ValidateSNSSmsPluginEndpointAction()
action.testMessage = "test message"
action.uuid = "d6973dc39d7437dd805b3a07b7f60975"
action.phoneNumbers = ["+86-18612345678"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇更新插件通知平台(UpdateSNSPluginPlatform)下一篇创建插件短信消息模板(CreateSNSPluginTextTemplate)