GetSignatureIdentList - 获取审核通过的短信资质列表--短信服务-火山引擎

文档中心

立即注册

导航

GetSignatureIdentList - 获取审核通过的短信资质列表

最近更新时间：2024.07.01 10:41:21首次发布时间：2024.07.01 10:41:21

短信服务使用方可以调取GetSignatureIdentList接口获取并查询短信资质列表

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetSignatureIdentList	要执行的操作，取值：GetSignatureIdentList。
Version	String	是	2021-01-11	API的版本，取值：2021-01-11。
ids	Array of Integer	否	12	资质id列表
pageIndex	Integer	是	1	页码下标
pageSize	Integer	是	10	页面大小

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
list	Array of SignatureIdentificationListForSDKResp	资质列表	资质
total	Integer	资质总数	列表总数

请求示例

POST /?Action=GetSignatureIdentList&Version=2021-01-11 HTTP/1.1
Host: https://sms.volcengineapi.com/GetSignatureIdentList
Content-Type: application/json; charset=UTF-8
X-Date: 20240617T125659Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240617/cn-beijing/volcSMS/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ids": [
    779
  ],
  "pageIndex": 1,
  "pageSize": 10
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202406172057131310562331972260C1",
    "Action": "GetSignatureIdentList",
    "Version": "2021-01-11",
    "Service": "volcSMS",
    "Region": "cn-beijing"
  },
  "Result": {
    "list": [
      {
        "id": 953,
        "purpose": 911,
        "materialName": "0",
        "businessCertificateName": "YRI",
        "operatorPersonName": "9QN",
        "responsiblePersonName": "EBFb",
        "effectSignatures": [
          "Zc7EWlvxuwK"
        ]
      }
    ],
    "total": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误