添加短信接收者(AddSNSSmsReceiver)

API请求

URLs

POST zstack/v1/sns/sms-endpoints/receivers

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "phoneNumber": "13333333333",
    "phoneNumberList": [
      "13333333333"
    ],
    "endpointUuid": "467e77c4cc42492f9794429e689a9874",
    "type": "AliyunSms",
    "description": "description"
  },
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"phoneNumber":"13333333333","phoneNumberList":["13333333333"],"endpointUuid":"467e77c4cc42492f9794429e689a9874","type":"AliyunSms","description":"description"}}' \
http://localhost:8080/zstack/v1/sns/sms-endpoints/receivers

参数列表

名字	类型	位置	描述	可选值	起始版本
phoneNumber (可选)	String	body(包含在params结构中)	单个接收号码；与phoneNumberList至少提供一项，同时提供时使用phoneNumberList		3.7.0
phoneNumberList (可选)	List	body(包含在params结构中)	号码列表不能重复或包含已有号码；添加后接收者总数最多200个		5.1.8
endpointUuid	String	body(包含在params结构中)	短信接收端Uuid		3.7.0
type	String	body(包含在params结构中)	短信接收端类型；插件短信通知对象填写Plugin	AliyunSms UniversalSms Plugin	3.7.0
description (可选)	String	body(包含在params结构中)	短信接收者描述		3.7.0
resourceUuid (可选)	String	body(包含在params结构中)			3.7.0
tagUuids (可选)	List	body(包含在params结构中)	标签UUID列表		3.7.0
systemTags (可选)	List	body	系统标签		3.7.0
userTags (可选)	List	body	用户标签		3.7.0

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "f577c6472842420a87efff64634ba8ea",
      "phoneNumber": "18912345678",
      "endpointUuid": "f2d20aa7077147d29c6d40fc7b6d6d6a",
      "type": "AliyunSms",
      "description": "description",
      "createDate": "Sep 17, 2026 2:34:51 PM",
      "lastOpDate": "Sep 17, 2026 2:34:51 PM"
    }
  ]
}

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	3.7.0
inventories	List	详情参考inventories	5.1.8

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	5.3.20
description	String	错误的概要描述	5.3.20
details	String	错误的详细信息	5.3.20
elaboration	String	保留字段，默认为null	5.3.20
opaque	LinkedHashMap	保留字段，默认为null	5.3.20
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	5.3.20

#inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	3.7.0
phoneNumber	String	短信接收号码	3.7.0
endpointUuid	String	短信接收端Uuid	3.7.0
description	String	短信接收者描述	3.7.0
createDate	Timestamp	创建时间	3.7.0
lastOpDate	Timestamp	最后一次修改时间	3.7.0
type	SmsReceiverType	详情参考type	3.7.0

#type

名字	类型	描述	起始版本
AliyunSms	SmsReceiverType	阿里云短信	3.7.0

SDK示例

Java SDK

AddSNSSmsReceiverAction action = new AddSNSSmsReceiverAction();
action.phoneNumber = "13333333333";
action.phoneNumberList = java.util.Arrays.asList("13333333333");
action.endpointUuid = "467e77c4cc42492f9794429e689a9874";
action.type = "AliyunSms";
action.description = "description";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AddSNSSmsReceiverAction.Result res = action.call();

Python SDK

action = AddSNSSmsReceiverAction()
action.phoneNumber = "13333333333"
action.phoneNumberList = ["13333333333"]
action.endpointUuid = "467e77c4cc42492f9794429e689a9874"
action.type = "AliyunSms"
action.description = "description"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

上一篇刷新插件驱动器(RefreshPluginDrivers)下一篇删除短信接收者(RemoveSNSSmsReceiver)