# 添加订阅用户 - CreateSubscriptionUser
#### 功能介绍
添加订阅用户。如果订阅用户的状态为未确认，则会向订阅用户发送一条确认订阅消息。订阅用户点击订阅链接确认订阅后，则订阅用户的状态变更为已确认，同时会向订阅用户发送一条取消订阅消息，便于订阅用户随时可以取消订阅。订阅用户点击取消订阅链接后，则订阅用户的状态变更为已取消，同时会向订阅用户发送一条重新订阅消息，便于订阅用户可以重新订阅。该接口属于全局api，调用时需要进行全局授权，即X-Auth-Token需要传入domain级别的token。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-smn/smn_api_30000.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-smn/smn_api_80000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                         | 访问级别  | 资源类型（\*为必须）          | 条件键                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | smn:subscriptionUser:create | Write | subscription_user \* | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -  | -      |
  | smn:subscriptionUser:create | Write | -                    | - smn:Protocol   - smn:Endpoint    | -  | -      |
     
  
 
#### URI
POST /v2/{domain_id}/subscription-users
表1路径参数 
| 参数        | 是否必选 | 参数类型   | 描述      |
|:---|:---|:---|:---|
| domain_id | 是    | String | 租户账号ID。 |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                             |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 该接口属于全局API调用时需要进行全局授权，即X-Auth-Token需要传入domain级别的token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表3请求Body参数 
| 参数            | 是否必选 | 参数类型                                                                                                                                                                              | 描述                                                                          |
|:---|:---|:---|:---|
| name          | 是    | String                                                                                                                                                                            | 订阅用户名称。                                                                     |
| group         | 否    | Array of strings                                                                                                                                                                  | 订阅用户分组。每个订阅分组只能包含中英文、数字(\[0-9\])、下划线(_)，下划线不能出现在开始或结尾，下划线不能连续出现，长度为1到32个字符。 |
| http          | 否    | [CreateSubscriptionUserRequestHttpEndpointInfo] object               | http协议订阅用户终端地址。                                                             |
| https         | 否    | [CreateSubscriptionUserRequestHttpsEndpointInfo] object             | https协议订阅用户终端地址。                                                            |
| sms           | 否    | [CreateSubscriptionUserRequestSmsEndpointInfo] object                 | sms协议订阅用户终端地址，可与callnotify协议同时创建，终端地址必须完全相同。                                |
| email         | 否    | [CreateSubscriptionUserRequestEmailEndpointInfo] object             | email协议订阅用户终端地址。                                                            |
| callnotify    | 否    | [CreateSubscriptionUserRequestCallnotifyEndpointInfo] object   | 语音通知协议订阅用户的终端信息，可与sms协议同时存在，但终端地址必须完全相同。                                    |
| wechat        | 否    | [CreateSubscriptionUserRequestWechatEndpointInfo] object           | 微信群机器人协议订阅用户终端地址。                                                           |
| dingding      | 否    | [CreateSubscriptionUserRequestDingdingEndpointInfo] object       | 钉钉群机器人协议订阅用户的终端信息。                                                          |
| feishu        | 否    | [CreateSubscriptionUserRequestFeishuEndpointInfo] object           | 飞书群机器人协议订阅用户的终端信息。                                                          |
| welink        | 否    | [CreateSubscriptionUserRequestWelinkEndpointInfo] object           | WeLink群机器人协议订阅用户的终端信息。                                                      |
| ding_talk_bot | 否    | [CreateSubscriptionUserRequestDingTalkBotEndpointInfo] object | 个人钉钉协议订阅用户的终端信息。                                                            |
   
 表4CreateSubscriptionUserRequestHttpEndpointInfo 
| 参数       | 是否必选 | 参数类型                 | 描述                                    |
|:---|:---|:---|:---|
| endpoint | 是    | String               | 终端地址。必须以"http://"开头。                  |
| header   | 否    | Map\<String,String\> | http协议订阅用户的自定义请求头。http协议订阅用户可以自定义请求头。 |
   
 表5CreateSubscriptionUserRequestHttpsEndpointInfo 
| 参数       | 是否必选 | 参数类型                 | 描述                                      |
|:---|:---|:---|:---|
| endpoint | 是    | String               | 终端地址。必须以"https://"开头。                   |
| header   | 否    | Map\<String,String\> | https协议订阅用户的自定义请求头。https协议订阅用户可以自定义请求头。 |
   
 表6CreateSubscriptionUserRequestSmsEndpointInfo 
| 参数                        | 是否必选 | 参数类型    | 描述                                                                                                                              |
|:---|:---|:---|:---|
| endpoint                  | 是    | String  | 终端地址。必须是一个电话号码。                                                                                                                 |
| verification_code_enabled | 否    | Boolean | 是否启用验证码，默认为false。当protocol值为sms或callnotify，且该字段值设置为true时，发送订阅确认短信为验证码格式；该字段为false或者不存在时，发送的订阅确认短信为超链接格式。当protocol值为其他协议时，该字段不生效 |
   
 表7CreateSubscriptionUserRequestEmailEndpointInfo 
| 参数       | 是否必选 | 参数类型   | 描述            |
|:---|:---|:---|:---|
| endpoint | 是    | String | 终端地址。必须是邮件地址。 |
   
 表8CreateSubscriptionUserRequestCallnotifyEndpointInfo 
| 参数                        | 是否必选 | 参数类型    | 描述                                                                                                                              |
|:---|:---|:---|:---|
| endpoint                  | 是    | String  | 终端地址。必须是一个电话号码。                                                                                                                 |
| verification_code_enabled | 否    | Boolean | 是否启用验证码，默认为false。当protocol值为sms或callnotify，且该字段值设置为true时，发送订阅确认短信为验证码格式；该字段为false或者不存在时，发送的订阅确认短信为超链接格式。当protocol值为其他协议时，该字段不生效 |
   
 表9CreateSubscriptionUserRequestWechatEndpointInfo 
| 参数       | 是否必选 | 参数类型   | 描述                   |
|:---|:---|:---|:---|
| endpoint | 是    | String | 终端地址。必须是一个微信群机器人的地址。 |
   
 表10CreateSubscriptionUserRequestDingdingEndpointInfo 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                             |
|:---|:---|:---|:---|
| endpoint    | 是    | String | 终端地址。必须是一个钉钉群机器人的地址。                                                                                           |
| keyword     | 否    | String | dingding协议订阅用户的关键字。dingding协议订阅用户必须指定keyword和sign_secret二者之一。当用户在钉钉机器人端添加关键字校验的安全策略时，这里的关键字必须是钉钉端所填写的关键字之一。    |
| sign_secret | 否    | String | dingding协议订阅用户的加签密钥字段。dingding协议订阅用户必须指定keyword和sign_secret二者之一。当用户在钉钉机器人端添加关键字校验的安全策略时，这里的关键字必须是钉钉端所填写的关键字之一。 |
   
 表11CreateSubscriptionUserRequestFeishuEndpointInfo 
| 参数          | 是否必选 | 参数类型   | 描述                                                                                                         |
|:---|:---|:---|:---|
| endpoint    | 是    | String | 终端地址。必须是一个飞书群机器人的地址。                                                                                       |
| keyword     | 否    | String | feishu协议订阅用户的关键字。feishu协议订阅用户必须指定keyword和sign_secret二者之一。当用户在飞书机器人端添加关键字校验的安全策略时，这里的关键字必须是飞书端所填写的关键字之一。    |
| sign_secret | 否    | String | feishu协议订阅用户的加签密钥字段。feishu协议订阅用户必须指定keyword和sign_secret二者之一。当用户在飞书机器人端添加关键字校验的安全策略时，这里的关键字必须是飞书端所填写的关键字之一。 |
   
 表12CreateSubscriptionUserRequestWelinkEndpointInfo 
| 参数            | 是否必选 | 参数类型   | 描述                                     |
|:---|:---|:---|:---|
| endpoint      | 是    | String | 终端地址。必须是一个welink的群号。                   |
| client_id     | 是    | String | welink协议订阅用户的client_id，从Welink方获取。     |
| client_secret | 是    | String | welink协议订阅用户的client_secret，从Welink方获取。 |
   
 表13CreateSubscriptionUserRequestDingTalkBotEndpointInfo 
| 参数         | 是否必选 | 参数类型   | 描述               |
|:---|:---|:---|:---|
| endpoint   | 是    | String | 钉钉企业用户的userId。   |
| app_key    | 是    | String | 个人钉钉appKey字段。    |
| app_secret | 是    | String | 个人钉钉appSecret字段。 |
| robot_code | 是    | String | 个人钉钉robotCode字段。 |
   
#### 响应参数
**状态码：201**
表14响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| request_id | String | 请求的唯一标识ID。 |
| id         | String | 订阅用户ID。    |
   
**状态码：400**
表15响应Body参数 
| 参数         | 参数类型   | 描述          |
|:---|:---|:---|
| request_id | String | 请求的唯一标识ID。  |
| error_code | String | 返回信息对应的代码。  |
| error_msg  | String | 服务异常错误信息描述。 |
   
**状态码：403**
表16响应Body参数 
| 参数         | 参数类型   | 描述          |
|:---|:---|:---|
| request_id | String | 请求的唯一标识ID。  |
| error_code | String | 返回信息对应的代码。  |
| error_msg  | String | 服务异常错误信息描述。 |
   
**状态码：404**
表17响应Body参数 
| 参数         | 参数类型   | 描述          |
|:---|:---|:---|
| request_id | String | 请求的唯一标识ID。  |
| error_code | String | 返回信息对应的代码。  |
| error_msg  | String | 服务异常错误信息描述。 |
   
**状态码：500**
表18响应Body参数 
| 参数         | 参数类型   | 描述          |
|:---|:---|:---|
| request_id | String | 请求的唯一标识ID。  |
| error_code | String | 返回信息对应的代码。  |
| error_msg  | String | 服务异常错误信息描述。 |
   
#### 请求示例
创建一个名称为test的邮件协议订阅用户
```
POST https://{SMNGLOBAL_Endpoint}/v2/{domain_id}/subscription-users 
{
  "name" : "test",
  "email" : {
    "endpoint" : "xxx@example.com"
  }
}
```
#### 响应示例
**状态码：201**
OK
```
{
  "request_id" : "4143732b537348ecb69688da56d629c4",
  "id" : "e08d1d82a57a4772b353d85445cefd7b"
}
```
#### SDK代码示例
SDK代码示例如下。
- [Java]
  创建一个名称为test的邮件协议订阅用户
  ```
  package com.huaweicloud.sdk.test;
  import com.huaweicloud.sdk.core.auth.ICredential;
  import com.huaweicloud.sdk.core.auth.GlobalCredentials;
  import com.huaweicloud.sdk.core.exception.ConnectionException;
  import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
  import com.huaweicloud.sdk.core.exception.ServiceResponseException;
  import com.huaweicloud.sdk.smnglobal.v2.region.SmnglobalRegion;
  import com.huaweicloud.sdk.smnglobal.v2.*;
  import com.huaweicloud.sdk.smnglobal.v2.model.*;
  public class CreateSubscriptionUserSolution {
      public static void main(String[] args) {
          // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
          // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
          String ak = System.getenv("CLOUD_SDK_AK");
          String sk = System.getenv("CLOUD_SDK_SK");
          ICredential auth = new GlobalCredentials()
                  .withAk(ak)
                  .withSk(sk);
          SmnglobalClient client = SmnglobalClient.newBuilder()
                  .withCredential(auth)
                  .withRegion(SmnglobalRegion.valueOf("<YOUR REGION>"))
                  .build();
          CreateSubscriptionUserRequest request = new CreateSubscriptionUserRequest();
          CreateSubscriptionUserRequestBody body = new CreateSubscriptionUserRequestBody();
          CreateSubscriptionUserRequestEmailEndpointInfo emailbody = new CreateSubscriptionUserRequestEmailEndpointInfo();
          emailbody.withEndpoint("xxx@example.com");
          body.withEmail(emailbody);
          body.withName("test");
          request.withBody(body);
          try {
              CreateSubscriptionUserResponse response = client.createSubscriptionUser(request);
              System.out.println(response.toString());
          } catch (ConnectionException e) {
              e.printStackTrace();
          } catch (RequestTimeoutException e) {
              e.printStackTrace();
          } catch (ServiceResponseException e) {
              e.printStackTrace();
              System.out.println(e.getHttpStatusCode());
              System.out.println(e.getRequestId());
              System.out.println(e.getErrorCode());
              System.out.println(e.getErrorMsg());
          }
      }
  }
  ```
- [Python]
  创建一个名称为test的邮件协议订阅用户
  ```
  # coding: utf-8
  import os
  from huaweicloudsdkcore.auth.credentials import GlobalCredentials
  from huaweicloudsdksmnglobal.v2.region.smnglobal_region import SmnglobalRegion
  from huaweicloudsdkcore.exceptions import exceptions
  from huaweicloudsdksmnglobal.v2 import *
  if __name__ == "__main__":
      # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak = os.environ["CLOUD_SDK_AK"]
      sk = os.environ["CLOUD_SDK_SK"]
      credentials = GlobalCredentials(ak, sk)
      client = SmnglobalClient.new_builder() \
          .with_credentials(credentials) \
          .with_region(SmnglobalRegion.value_of("<YOUR REGION>")) \
          .build()
      try:
          request = CreateSubscriptionUserRequest()
          emailbody = CreateSubscriptionUserRequestEmailEndpointInfo(
              endpoint="xxx@example.com"
          )
          request.body = CreateSubscriptionUserRequestBody(
              email=emailbody,
              name="test"
          )
          response = client.create_subscription_user(request)
          print(response)
      except exceptions.ClientRequestException as e:
          print(e.status_code)
          print(e.request_id)
          print(e.error_code)
          print(e.error_msg)
  ```
- [Go]
  创建一个名称为test的邮件协议订阅用户
  ```
  package main
  import (
  "fmt"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
      smnglobal "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2"
  "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2/model"
      region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smnglobal/v2/region"
  )
  func main() {
      // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
      // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
      ak := os.Getenv("CLOUD_SDK_AK")
      sk := os.Getenv("CLOUD_SDK_SK")
      auth, err := global.NewCredentialsBuilder().
          WithAk(ak).
          WithSk(sk).
          SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      hcClient, err := smnglobal.SmnglobalClientBuilder().
           WithRegion(region.ValueOf("<YOUR REGION>")).
           WithCredential(auth).
           SafeBuild()
      if err != nil {
          fmt.Println(err)
          return
      }
      client := smnglobal.NewSmnglobalClient(hcClient)
      request := &model.CreateSubscriptionUserRequest{}
  emailbody := &model.CreateSubscriptionUserRequestEmailEndpointInfo{
  Endpoint: "xxx@example.com",
  }
  request.Body = &model.CreateSubscriptionUserRequestBody{
  Email: emailbody,
  Name: "test",
  }
  response, err := client.CreateSubscriptionUser(request)
  if err == nil {
          fmt.Printf("%+v\n", response)
      } else {
          fmt.Println(err)
      }
  }
  ```
- [更多]
  更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMNGLOBAL/sdk?api=CreateSubscriptionUser&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。
#### 状态码
| 状态码 | 描述                    |
|:---|:---|
| 201 | OK                    |
| 400 | Bad Request           |
| 403 | Unauthorized          |
| 404 | Not Found             |
| 500 | Internal Server Error |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-smn/ErrorCode.html)。