You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航

查询视频短信模版审核结果GetVmsTemplateStatus

最近更新时间2023.03.01 17:32:56

首次发布时间2023.03.01 17:32:56

短信服务使用方可以调用GetVmsTemplateStatus接口,查询短视频信模板审核结果。

接口说明

  • 请求方式:POST

  • 接口地址:https://sms.volcengineapi.com/?Action=GetVmsTemplateStatus&Version=2021-01-11&area=cn&subAccount=19cb0b72

请求参数

参数数据类型是否必填示例值描述

AccessKey

string

AKLTNzEzY2****

发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。

SecretKey

string

RGTLuSHvnYxn****

发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。

ServiceNamestringvolcSMS服务名称。短信服务的服务名称为volcSMS
Regionstringcn-north-1区域名称。该接口的区域名称为cn-north-1

Content-Type

string

application/json;charset=utf-8

指定请求消息体的结构化格式。短信服务的 Content-Type 为application/json;charset=utf-8

Query

参数是否必填数据类型示例值描述
ActionstringGetVmsTemplateStatus接口名称。该接口固定值为GetVmsTemplateStatus
Versionstring2021-01-11接口版本。短信服务接口版本为2021-01-11

Body

参数类型是否必填示例值描述
subAccountstringA123****消息组ID
templateIdstringST_712****模版ID

返回参数

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

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

ResponseMetadata

参数数据类型描述
RequestIdstring请求 ID。
Actionstring请求的接口名称。
Versionstring请求的版本号。
Servicestring请求的服务名称。
Regionstring请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error

Result

参数数据类型描述
ApplyResultlist各个运营商审核结果列表

ApplyResult

参数数据类型描述

carrier

string

运营商名称枚举
China Mobile、
China Telecom、
China Unicom

statusint模版审核状态;1: 审核中,2: 未通过,3: 已开通,4: 已关闭,5: 免审
reasonstring失败原因(部分失败情况会有)

Error

参数数据类型描述
Codestring错误码。
Messagestring错误信息。

示例

请求示例

https://sms.volcengineapi.com/?Action=GetVmsTemplateStatus&Version=2021-01-11&area=cn&subAccount=19cb0b72

返回示例

正确返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230301143618A42DDB897D67B7CC1EEE",
        "Action": "",
        "Version": "",
        "Service": "",
        "Region": ""
    },
    "Result": {
        "ApplyResult": [
            {
                "carrier": "China Telecom",
                "status": 3,
                "reason": ""
            },
            {
                "carrier": "China Mobile",
                "status": 1,
                "reason": ""
            },
            {
                "carrier": "China Unicom",
                "status": 3,
                "reason": ""
            }
        ]
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "Action": "GetVmsTemplateStatus",
        "Error": {
            "Code": "RE:0005",
            "CodeN": 0,
            "Message": "模板错误"
        },
        "Region": "cn-north-1",
        "RequestId": "20230215142412486D5161C93A8167CD7E",
        "Service": "volcSMS",
        "Version": "2021-01-11"
    }
}

错误码

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

CodeMessage说明处理建议
1001错误描述参数错误
1015exceed qps limit超过接口频控限制
1999错误描述系统错误