获取消息组列表GetSubAccountList

最近更新时间：2023.04.20 19:36:53

首次发布时间：2023.01.17 16:19:30

短信服务方可调用GetSubAccountList接口查询并获取消息组列表。

接口说明

请求方式：GET
接口地址：https://sms.volcengineapi.com?Action=GetSubAccountList&Version=2021-01-11

请求参数

参数	数据类型	是否必填	示例值	描述
AccessKey	string	是	AKLTNzEzY2****	发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。
SecretKey	string	是	RGTLuSHvnYxn****	发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。
ServiceName	string	是	volcSMS	服务名称。短信服务的服务名称为`volcSMS`。
Region	string	是	cn-north-1	区域名称。短信服务的区域名称为`cn-north-1`。
Content-Type	string	是	application/json;charset=utf-8	指定请求消息体的结构化格式。短信服务的 Content-Type 为`application/json;charset=utf-8`。

Query

参数	数据类型	是否必填	示例值	描述
Action	string	是	GetSubAccountList	接口名称。该接口固定值为`GetSubAccountList`。
Version	string	是	2021-01-11	接口版本。短信服务接口版本为`2021-01-11`。
subAccount	string	否	A123****	消息组ID
subAccountName	string	否	测试消息组	消息组名称

返回参数

请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见返回结果。

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见Result。

ResponseMetadata

参数	数据类型	描述
RequestId	string	请求的唯一ID
Action	string	请求的方法
Version	string	请求的版本
Service	string	请求的服务
Region	string	请求的区域
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见Error。

Result

参数	数据类型	描述
list	Array	消息组列表，详见SubAccountInfo。

SubAccountInfo

参数	数据类型	描述
subAccountName	string	消息组名称
subAccountId	string	消息组ID
createdTime	int64	消息组创建时间

Error

参数	数据类型	描述
Code	string	错误码。
Message	string	错误信息。

示例

请求示例

http://sms.volcengineapi.com/?Action=GetSubAccountList&Version=2021-01-11&subAccountName=消息组名称

返回示例

正确返回示例

{
    "ResponseMetadata":{
        "RequestId":"20220908184707010174255202048F8891",
        "Action":"GetSubAccountList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "subAccountName":"通道池测试消息组",
                "subAccountId":"6e54bb22",
                "createdTime":1649799715
            }
        ],
        "total":1
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId":"20220908184707010174255202048F8891",
        "Action":"GetSubAccountList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1",
        "Error": {
            "Code": "ZJ10200",
            "Message": "请求参数错误"
        }
    }
}

错误码

如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。

Code	Message	说明	处理建议
1001	错误描述	参数错误
1999	错误描述	系统错误