添加短信接收者(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结构中)	短信接收号码		3.7.0
phoneNumberList（可选）	List	body(包含在params结构中)	短信接收号码列表		5.1.8
endpointUuid	String	body(包含在params结构中)	短信接收端Uuid		3.7.0
type	String	body(包含在params结构中)	短信接收端类型	AliyunSms UniversalSms	5.1.8
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": "d122a14806e8405894d00034b0a91dd1",
      "phoneNumber": "18912345678",
      "endpointUuid": "d539f1d109534f90b0cbf50cff412585",
      "type": "AliyunSms",
      "description": "description",
      "createDate": "Jun 13, 2024 5:29:04 PM",
      "lastOpDate": "Jun 13, 2024 5:29:04 PM"
    }
  ]
}

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

#error

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

#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
UniversalSms	SmsReceiverType	通用短信	5.1.8

SDK示例

Java SDK

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

Python SDK

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

上一篇查询通用短信接收端(QuerySNSUniversalSmsEndpoint)下一篇删除短信接收者(RemoveSNSSmsReceiver)