Skip to main content
ZStack
Platform O&M/Cloud Monitoring/Monitoring and Alarm/SNS/SNS Operations

AddSNSSmsReceiver

AddSNSSmsReceiver

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

Operation ID

AddSNSSmsReceiver

Since

3.7.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • phoneNumber
      String

      Optional. The single receiver phone number. At least one of this field and phoneNumberList must be provided. If both are provided, phoneNumberList is used.

    • phoneNumberList
      List

      Optional. The list cannot contain duplicates or existing numbers. The total number of receivers cannot exceed 200 after the addition.

    • endpointUuid
      StringRequired

      The SMS endpoint UUID.

    • type
      StringRequired

      The SMS endpoint type. Set this field to Plugin for an SMS plugin notification endpoint.

    • description
      String

      Optional. The SMS receiver description.

    • resourceUuid
      String

      Optional.

    • tagUuids
      List

      Optional. The tag UUID list.

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventories
    ListRequired

    For more information, see inventories.

    • uuid
      StringRequired

      The resource UUID, which uniquely identifies the resource.

    • phoneNumber
      StringRequired

      The SMS receiver phone number.

    • endpointUuid
      StringRequired

      The SMS endpoint UUID.

    • description
      StringRequired

      The SMS receiver description.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

    • type
      SmsReceiverTypeRequired

      For more information, see type.

      • AliyunSms
        SmsReceiverTypeRequired

        Aliyun SMS

Change History

View all change history

  • Change Time

    DeletedResponse fields UniversalSms, success
    View API