短信服务使用方可调用GetSubAccountDetail接口获取并查询消息组详情。
GET
https://sms.volcengineapi.com?Action=GetSubAccountDetail&Version=2021-01-11
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSubAccountDetail | 要执行的操作,取值:GetSubAccountDetail |
Version | String | 是 | 2021-01-11 | API的版本,取值:2021-01-11 |
subAccount | String | 是 | 消息组ID |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ResponseMetadata | ResponseMetadata | 响应公共参数。 | |
Result | SubAccountInfo | 响应业务参数。 |
https://sms.volcengineapi.com?Action=GetSubAccountDetail&Version=2021-01-11&subAccount=6e54****
{
"ResponseMetadata":{
"RequestId":"2022090818541801022524312500A5****",
"Action":"GetSubAccountDetail",
"Version":"2021-01-11",
"Service":"volcSMS",
"Region":"cn-north-1"
},
"Result":{
"subAccountName":"测试消息组",
"subAccountId":"6e54****",
"createdTime":1649799715,
"status":1,
"desc":"",
"enabledChannelType":[
{
"name":"国内通知短信",
"value":"CN_NTC",
"area":"cn"
},
{
"name":"国内营销短信",
"value":"CN_MKT",
"area":"cn"
},
{
"name":"国内验证码",
"value":"CN_OTP",
"area":"cn"
},
{
"name":"国际验证码短信",
"value":"I18N_OTP",
"area":"overseas"
},
{
"name":"国际营销短信",
"value":"I18N_MKT",
"area":"overseas"
}
]
}
}
https://sms.volcengineapi.com?Action=GetSubAccountDetail&Version=2021-01-11
{
"ResponseMetadata": {
"RequestId":"20220908184707010174255202048F****",
"Action":"GetSubAccountDetail",
"Version":"2021-01-11",
"Service":"volcSMS",
"Region":"cn-north-1",
"Error": {
"Code": "1001",
"Message": " not found"
}
}
}
下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
200 | 1001 | 参数错误 | 参数错误 |
200 | 1999 | 系统错误 | 系统错误 |