查询短信签名

功能介绍

该接口用于用户查询已创建的短信签名。

URI

GET /v1/sms/signatures

表1 Query参数
参数	是否必选	参数类型	描述
app_name	否	String	应用名称。
signature_id	否	String	签名ID。
signature_name	否	String	签名名称。
signature_type	否	String	签名类型。
begin_time	否	String	开始时间。
end_time	否	String	结束时间。
status	否	String	状态。
limit	否	Integer	每页显示的条目数量。
offset	否	String	偏移量，表示从此偏移量开始查询，offset大于等于0。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
result	Array of SmsSignatureInfo objects	查询结果。
page_info	Page object	分页信息。

表4 SmsSignatureInfo
参数	参数类型	描述
signature_name	String	签名名称。最小长度：1 最大长度：30
signature_id	String	签名ID。最小长度：1 最大长度：50
signature_type	String	签名类型。最小长度：1 最大长度：20
app_name	String	应用名称。最小长度：1 最大长度：30
app_id	String	应用ID。最小长度：1 最大长度：50
apply_desc	String	申请说明。最小长度：0 最大长度：100
channel_num	String	国内短信通道号，仅当签名审核成功，运营人员配置完成后返回。最小长度：1 最大长度：21
file_id	String	营业执照文件ID。最小长度：1 最大长度：50
status	String	状态。枚举值： PENDING_REVIEW：待审核 PROCESSING：内容审核通过签名在处理中 REVIEW_PASSED：处理完毕 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中
signature_source	Integer	签名来源。最小值：0 最大值：20
is_involved_third	String	是否涉及第三方权益。
power_attorney_file_id	String	授权委托书文件ID。最小长度：1 最大长度：50
urge_status	String	催审状态。最小长度：1 最大长度：20
urge_time	String	催审时间。最小长度：1 最大长度：20
urge_desc	String	催审描述。最小长度：0 最大长度：64
review_desc	String	审核意见。最小长度：0 最大长度：500
source_title_content	String	标题内容。最小长度：1 最大长度：180
create_time	String	创建时间。最小长度：1 最大长度：20

表5 Page
参数	参数类型	描述
offset	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。
limit	Integer	每页显示的条目数量。
total	Integer	总条数。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。最小长度：0 最大长度：32
error_msg	String	结果详情。最小长度：0 最大长度：32

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。最小长度：0 最大长度：32
error_msg	String	结果详情。最小长度：0 最大长度：32

请求示例

查询应用Huawei_12688下审核通过的短信签名。

https://koomessage.myhuaweicloud.cn/v1/sms/signatures?app_name=Huawei_12688&status=REVIEW_PASSED

响应示例

状态码： 200

返回信息。

{
  "result" : [ {
    "signature_name" : "签名创建测试5555",
    "signature_id" : "23a73eef-0790-49e4-9735-7****27a3bc5",
    "signature_type" : "PROMOTION_TYPE",
    "app_name" : "Huawei_12688",
    "app_id" : "2353cb25-c169-4e20-adcf-3****b4e0f9e",
    "apply_desc" : "203测试",
    "channel_num" : "882308042****",
    "file_id" : "c2d3613c-2864-48ce-8de6-db****23ad32",
    "status" : "PENDING_REVIEW",
    "signature_source" : 0,
    "is_involved_third" : "no",
    "power_attorney_file_id" : null,
    "source_title_content" : "",
    "urge_status" : null,
    "urge_time" : null,
    "urge_desc" : null,
    "review_desc" : null,
    "create_time" : "2023-08-07T02:28:45"
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 10,
    "total" : 1
  }
}