GetSubAccountList - 获取消息组列表--短信服务-火山引擎

文档中心

立即注册

导航

GetSubAccountList - 获取消息组列表

最近更新时间：2024.01.29 14:41:45首次发布时间：2023.01.17 16:19:30

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

请求说明

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

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	GetSubAccountList	要执行的操作，取值：GetSubAccountList
Version	String	是	2021-01-11	API的版本，取值：2021-01-11
subAccount	String	否	A123****	消息组ID
subAccountName	String	否	测试消息组	消息组名称

响应数据

名称	类型	示例值	描述
ResponseMetadata	ResponseMetadata		响应公共参数。
Result	GetSubAccountListResp		响应业务参数

示例

成功请求示例

请求

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

响应

{
    "ResponseMetadata":{
        "RequestId":"20220908184707010174255202048F****",
        "Action":"GetSubAccountList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "subAccountName":"测试消息组",
                "subAccountId":"6e54****",
                "createdTime":1649799715,
                "status":1,
                "desc":"描述信息"
            }
        ],
        "total":1
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误