Querying Subscribers

Function

This API is used to query subscribers.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
smn:subscriptionUser:list	List	subscription_user *	-	-	-

URI

GET /v2/{domain_id}/subscription-users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies the tenant's account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
name	No	String	Specifies the subscriber's name.
protocol	No	String	The subscription protocol. http: Notifications sent over HTTP https: Notifications sent over HTTPS sms: Notifications sent by SMS email: Notifications sent by email callnotify: Voice notifications wechat: Notifications delivered to an enterprise WeChat chatbot dingding: Notifications delivered to a DingTalk group chatbot feishu: Notifications delivered to a Lark group chatbot welink: Notifications delivered to a WeLink group chatbot ding_talk_bot: Notifications delivered to a DingTalk user
status	No	String	Specifies the subscriber's status. The value can be one of the following: UNCONFIRMED CONFIRMED CANCELLED
group	No	String	The subscriber's group. Fuzzy search is supported.
offset	No	Integer	Specifies the offset. If the offset is an integer greater than 0 but less than the number of resources, all resources after this offset will be queried. The default offset is 0.
limit	No	Integer	Specifies the maximum number of records in each query, that is, the number of resources returned on each page. The number ranges from 1 to 100 and is generally 10, 20, or 50. The default number is 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	This API is a global API. When it is called, global authorization is required, meaning that the X-Auth-Token must be a domain-level token. You can obtain it by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the unique request ID.
count	Integer	Specifies the number of subscribers.
subscription_users	Array of ListSubscriptionUserResponseItemInfo objects	Specifies the list of subscribers' information.
ding_talk_bot	ListSubscriptionUserResponseDingTalkBotEndpointInfo object	The endpoint for a DingTalk user.

**Table 5** ListSubscriptionUserResponseItemInfo
Parameter	Type	Description
id	String	Specifies the subscriber ID.
domain_id	String	Specifies the tenant's account ID.
name	String	Specifies the subscriber's name.
status	String	Specifies the subscriber's status. The value can be one of the following: UNCONFIRMED CONFIRMED CANCELLED
group	Array of strings	Specifies the subscriber's group.
create_time	String	Specifies the creation time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
update_time	String	Specifies the update time. The UTC time is in YYYY-MM-DDTHH:MM:SSZ format.
http	ListSubscriptionUserResponseHttpEndpointInfo object	Specifies the endpoint address of the user who subscribes over the HTTP protocol.
https	ListSubscriptionUserResponseHttpsEndpointInfo object	Specifies the endpoint address of the user who subscribes over the HTTPS protocol.
sms	ListSubscriptionUserResponseSmsEndpointInfo object	Specifies the endpoint address of the user who subscribes over the SMS protocol.
email	ListSubscriptionUserResponseEmailEndpointInfo object	Specifies the endpoint address of the user who subscribes over the email protocol.
callnotify	ListSubscriptionUserResponseCallnotifyEndpointInfo object	The endpoint for the voice notification protocol.
wechat	ListSubscriptionUserResponseWechatEndpointInfo object	The endpoint for the WeCom group chatbot transmission protocol.
dingding	ListSubscriptionUserResponseDingdingEndpointInfo object	The endpoint for the DingTalk group chatbot transmission protocol.
feishu	ListSubscriptionUserResponseFeishuEndpointInfo object	The endpoint for the Lark group chatbot transmission protocol.
welink	ListSubscriptionUserResponseWelinkEndpointInfo object	The endpoint for the WeLink group chatbot transmission protocol.

**Table 6** ListSubscriptionUserResponseHttpEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.
header	Map<String,String>	Specifies the user-defined request header of the HTTP subscriber.

**Table 7** ListSubscriptionUserResponseHttpsEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.
header	Map<String,String>	Specifies the user-defined request header of the HTTPS subscriber.

**Table 8** ListSubscriptionUserResponseSmsEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.

**Table 9** ListSubscriptionUserResponseEmailEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.

**Table 10** ListSubscriptionUserResponseCallnotifyEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.

**Table 11** ListSubscriptionUserResponseWechatEndpointInfo
Parameter	Type	Description
endpoint	String	The endpoint for which sensitive information has been hidden.

**Table 12** ListSubscriptionUserResponseDingdingEndpointInfo
Parameter	Type	Description
endpoint	String	The endpoint for which sensitive information has been hidden.
keyword	String	Specifies the keyword customized by the user who subscribes over the DingTalk chatbot. Either keyword or sign_secret must be specified by such a subscriber. When you add a keyword for security verification on the DingTalk robot, keyword must be one of the keywords entered on the DingTalk.
sign_secret	String	Specifies the signature customized by the user who subscribes over the DingTalk chatbot. Either keyword or sign_secret must be specified by such a subscriber. When you add a keyword for security verification on the DingTalk robot, keyword must be one of the keywords entered on the DingTalk.

**Table 13** ListSubscriptionUserResponseFeishuEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.
keyword	String	Specifies the keyword of the user who subscribes over the Lark chatbot. Either keyword or sign_secret must be specified by such a subscriber. When you add a keyword for security verification on the Lark robot, keyword must be one of the keywords entered on the Lark.
sign_secret	String	Specifies the signature key field of a user who subscribes over the Lark chatbot. Either keyword or sign_secret must be specified by such a subscriber. When you add a keyword for security verification on the Lark robot, keyword must be one of the keywords entered on the Lark.

**Table 14** ListSubscriptionUserResponseWelinkEndpointInfo
Parameter	Type	Description
endpoint	String	Specifies the endpoint address.
client_id	String	Specifies client_id of the user who subscribes over the WeLink protocol. Obtain the value of client_id from WeLink.

**Table 15** ListSubscriptionUserResponseDingTalkBotEndpointInfo
Parameter	Type	Description
endpoint	String	The DingTalk enterprise user ID.
robot_code	String	The code of the DingTalk chatbot.

Status code: 400

**Table 16** Response body parameters
Parameter	Type	Description
request_id	String	Unique ID of the request.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 17** Response body parameters
Parameter	Type	Description
request_id	String	Unique ID of the request.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 404

**Table 18** Response body parameters
Parameter	Type	Description
request_id	String	Unique ID of the request.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 19** Response body parameters
Parameter	Type	Description
request_id	String	Unique ID of the request.
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Example Requests

This API is used to list subscribers.

GET https://{SMNGLOBAL_Endpoint}/v2/{domain_id}/subscription-users?name=test&protocol=email&status=UNCONFIRMED&group=test_group1&offset=0&limit=100

Example Responses

Status code: 200

{
  "request_id" : "922a1e7af7ad49e5b3ad455306bbddef",
  "count" : 1,
  "subscription_users" : [ {
    "id" : "e08d1d82a57a4772b353d85445cefd7b",
    "domain_id" : "f7c690ceb6ef4846b897fde2af08befa",
    "name" : "test",
    "status" : "UNCONFIRMED",
    "group" : [ "test_group1" ],
    "create_time" : "2025-01-01T00:00:00Z",
    "update_time" : "2025-01-01T00:00:00Z",
    "email" : {
      "endpoint" : "xxx@example.com"
    }
  } ]
}

SDK Sample Code

The SDK sample code is as follows.

      
       
         
         
           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 ListSubscriptionUserSolution {

    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();
        ListSubscriptionUserRequest request = new ListSubscriptionUserRequest();
        try {
            ListSubscriptionUserResponse response = client.listSubscriptionUser(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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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 = ListSubscriptionUserRequest()
        response = client.list_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)

          

        

      
     

      
       
         
         
           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.ListSubscriptionUserRequest{}
	response, err := client.ListSubscriptionUser(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

          

        

      
     