查询签名信息 - ListSignatureDetails

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/msgsms/signatures

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID，参考“获取帐号、用户、项目的名称和ID”

表2 Query参数
参数	是否必选	参数类型	描述
app_name	否	String	应用名称
end_time	否	String	结束时间
start_time	否	String	开始时间
limit	否	Integer	数量默认值：10
offset	否	Integer	偏移量
signature_id	否	String	签名ID
signature_name	否	String	签名名称
signature_type	否	String	签名类型 VERIFY_CODE_TYPE：验证码类 PROMOTION_TYPE：推广类 NOTIFY_TYPE：通知类
site	否	String	站点，当前该参数暂不支持使用 cn：国内站 hk：国际站
sort_dir	否	String	排序方式，与排序字段搭配使用 desc：降序 asc：升序默认值：desc
sort_key	否	String	排序字段，与排序方式搭配使用仅支持create_time（创建时间）
status	否	String	签名状态 PENDING_REVIEW：待签名审核 PROCESSING：内容审核通过，签名处理中 REVIEW_PASSED：处理完毕（待补充资质），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中 PENDING_QUALIFICATION_REVIEW：待资质审核，该状态下，用户不可发送短信 REAL_NAME_REGISTRATING：实名报备中，该状态下，用户不可发送短信 REVIEW_PASSED_QUALIFICATION_PROCESSING：处理完毕（资质审核中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATING：处理完毕（实名报备中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATE_FAIL：处理完毕（实名报备失败），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PROCESSING_COMPLETED：处理完毕

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	请求体参数类型，该字段必须设置为：application/json;charset=utf8
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数
参数	是否必选	参数类型	描述
results	否	Array of SmsSignatureResp	查询结果
total	否	Long	总数

表5 响应SmsSignatureResp参数
参数	是否必选	参数类型	描述
id	否	String	签名主键ID，用于获取、修改、删除、申请激活签名的唯一标识
create_time	否	String	创建时间[yyyy-MM-dd HH:mm:ss]
update_time	否	String	更新时间[yyyy-MM-dd HH:mm:ss]
customer_id	否	String	租户customer id
tenant	否	表6 TentantBasic	-
signature_name	否	String	签名名称
signature_id	否	String	签名ID
signature_type	否	String	签名类型 VERIFY_CODE_TYPE：验证码类 PROMOTION_TYPE：推广类 NOTIFY_TYPE：通知类
app_name	否	String	应用名称
apply_desc	否	String	申请描述
channel_num	否	String	国内短信通道号，仅当签名审核成功，运营人员配置完成后返回
review_desc	否	String	审核意见
file_id	否	String	文件ID
status	否	String	签名状态 PENDING_REVIEW：待签名审核 PROCESSING：内容审核通过，签名处理中 REVIEW_PASSED：处理完毕（待补充资质），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中 PENDING_QUALIFICATION_REVIEW：待资质审核，该状态下，用户不可发送短信 REAL_NAME_REGISTRATING：实名报备中，该状态下，用户不可发送短信 REVIEW_PASSED_QUALIFICATION_PROCESSING：处理完毕（资质审核中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATING：处理完毕（实名报备中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATE_FAIL：处理完毕（实名报备失败），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PROCESSING_COMPLETED：处理完毕
site	否	String	站点，该参数暂不支持使用 cn：国内站 hk：国际站
signature_source	否	Integer	签名来源 0：企事业单位的全称或简称 1：工信部备案网站的全称或简称（已废弃） 2： APP应用的全称 3：公众号或小程序的全称或简称（已废弃） 4：电商平台店铺名的全称或简称（已废弃） 5：商标名的全称
is_involved_third	否	String	是否涉及第三方权益 Yes：是 No：否
power_attorney_file_id	否	String	授权委托书文件ID
urge_status	否	String	催审状态 NO：未催审 YES：已催审
urge_time	否	String	催审时间
urge_desc	否	String	催审描述
app_key	否	String	应用key
source_title_content	否	String	标题内容（已废弃）
signature_usage	否	String	签名用途
qualification_id	否	String	资质ID
qualification_name	否	String	资质名
signature_related_file_id	否	String	签名关联性截图ID
registration_number	否	String	商标申请/注册号
license_number	否	String	ICP备案/许可证号

表6 TentantBasic
参数	是否必选	参数类型	描述
customer_id	否	String	租户customer id
customer_name	否	String	租户customer name
enterprise_name	否	String	租户企业名称

请求示例

查询签名信息，返回签名信息，请求方式：GET，请求URI：/v2/{project_id}/msgsms/signatures，路径参数id，project_id；Query参数：limit（分页大小），offset（数据偏移量），app_name（应用名称）。

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures?signature_name=auto_test789 HTTP/1.1
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******

响应示例

{
    "results": [
        {
            "create_time": "2022-08-12 07:14:18",
            "customer_id": "******c55c3c4526b2ed7a0213bc9871",
            "id": "******bb-d48c-4c4d-b3da-baa8e4664852",
            "signature_name": "auto_test789",
            "signature_id": "******d1-196f-495f-abbe-42240469b8fc",
            "signature_type": "NOTIFY_TYPE",
            "app_name": "auto_test7890",
            "apply_desc": "test",
            "channel_num": "******1733968",
            "file_id": "******ab-1390-4268-9463-73db98cdc2e1",
            "status": "PENDING_REVIEW",
            "site": "cn",
            "signature_source": 0,
            "is_involved_third": "No",
            "urge_status": "NO",
            "app_key": "******3baZf4c856O4Qrbqvui3K2",
            "signature_usage": "COMMERCIAL",
            "signature_related_file_id": "******-8415-4419-a928-36386b3cbb4c",
            "registration_number": "89654**",
            "license_number": "沪ICP备15**535号"
        }
    ],
    "total": 1
}