GetSignatureAndOrderList - 获取短信签名和签名工单列表--短信服务-火山引擎

文档中心

立即注册

导航

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

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

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

请求说明

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

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	GetSignatureAndOrderList	要执行的操作，取值：GetSignatureAndOrderList
Version	String	是	2021-01-11	API的版本，取值：2021-01-11
subAccount	String	是	A123****	消息组ID
signature	String	否	短信签名	签名
pageIndex	Integer	否	1	分页值，默认为1
pageSize	Integer	否	1000	分页大小，默认为1000

响应数据

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

示例

成功请求示例

请求

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

响应

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

失败请求示例

请求

https://sms.volcengineapi.com/?Action=GetSignatureAndOrderList&Version=2021-01-11&signature=签名

响应

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

错误码

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

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误
200	1015	exceed qps limit	超过接口频控限制