跳转到主要内容
API Explorer|API Explorer
运维管理/监控相关接口/通知服务相关接口
POSTNotification Service APIs起始版本 3.7.0同步需要认证

添加短信接收者

添加短信接收者

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • phoneNumberString必填

      短信接收号码

    • endpointUuidString必填

      短信接收端Uuid

    • typeString必填

      短信接收端类型

    • descriptionString

      短信接收者描述

    • resourceUuidString

      资源UUID。若指定，资源会使用该字段值作为UUID。

    • tagUuidsList

      标签UUID列表

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventorySNSSmsReceiverInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • phoneNumberString必填

      短信接收号码

    • endpointUuidString必填

      短信接收端Uuid

    • descriptionString必填

      短信接收者描述

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • typeSmsReceiverType必填

      详情参考type

      • AliyunSmsSmsReceiverType必填

        阿里云短信

请求地址

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

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

操作 ID

AddSNSSmsReceiver

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/sns/sms-endpoints/receivers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"phoneNumber":"<phoneNumber>","endpointUuid":"<endpointUuid>","type":"<type>","description":"<description>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"]},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "fac44d00d50f41fda7c74b753ad4298e", "phoneNumber": "18912345678", "endpointUuid": "97c6a427da0e4c67ade85f488ddada53", "type": "AliyunSms", "description": "description", "createDate": "Mar 26, 2024 2:46:22 AM", "lastOpDate": "Mar 26, 2024 2:46:22 AM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史