获取短信签名和签名工单列表GetSignatureAndOrderList

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

首次发布时间：2023.01.17 16:20:07

短信服务使用方可以调取GetSignatureAndOrderList接口获取并查询短信签名列表。

接口说明

请求方式：GET
接口地址：https://sms.volcengineapi.com/?Action=GetSignatureAndOrderList&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	是	GetSignatureAndOrderList	接口名称。该接口固定值为`GetSignatureAndOrderList`。
Version	string	是	2020-01-11	接口版本。短信服务接口版本为`2021-01-11`。
subAccount	string	是	A123****	消息组ID
signature	string	否	火山引擎	签名
pageIndex	int	否	1	默认为1
pageSize	int	否	20	默认为1000

返回参数

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

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

ResponseMetadata

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

Result

参数	数据类型	描述
list	[]SignatureInfo	签名列表，包含的参数说明请参见SignatureInfo。

SignatureInfo

参数	数据类型	描述
id	string	签名ID
content	string	签名内容
application	string	签名用途
source	string	签名类型公司全称/简称；工信部备案网站全称/简称； APP全称/简称；公众号、小程序全称/简称；商标全称/简称；电商平台店铺名的全称/简称；
createdTime	int64	创建时间
status	int	审核状态。1:审核中，2:未通过，3:已开通，4:已关闭，5:免审
isOrder	bool	是否是审核工单
reason	string	审核意见，true即模版审核状态为“审核中”

Error

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

示例

请求示例

https://sms.volcengineapi.com/?Action=GetSignatureAndOrderList&Version=2021-01-11&subAccount=6df86000

返回示例

正确返回示例

{
    "ResponseMetadata":{
        "RequestId":"20220908184707010174255202048F8891",
        "Action":"GetSignatureAndOrderList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "id": "94369",
                "content": "你好",
                "application": "仅限公司内部使用",
                "source": "公司全称/简称",
                "status": 3,
                "isOrder": false,
                "createdTime":1649799715
            }
        ]
    }
}

错误返回示例

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

错误码

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

Code	Message	说明
1001	错误描述	参数错误
1015	exceed qps limit	超过接口频控限制
1999	错误描述	系统错误