查询签名信息
功能介绍
该接口用于用户查询已创建的短信签名信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/msgsms/signatures
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，参考“获取帐号、用户、项目的名称和ID” |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
app_name |
否 |
String |
应用名称 |
end_time |
否 |
String |
结束时间 |
limit |
否 |
Integer |
数量，默认值10 |
offset |
否 |
Integer |
偏移量 |
signature_id |
否 |
String |
签名ID |
signature_name |
否 |
String |
签名名称 |
signature_type |
否 |
String |
签名类型 |
site |
否 |
String |
地域，取值范围：cn及hk ，当前该参数暂时不使用 |
sort_dir |
否 |
String |
排序方式
|
sort_key |
否 |
String |
排序字段，仅支持create_time |
start_time |
否 |
String |
开始时间 |
status |
否 |
String |
状态
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
请求体参数类型，该字段必须设置为：application/json |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
results |
否 |
Array of SmsSignatureResp |
查询结果 |
total |
否 |
Long |
总数 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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 |
否 |
- |
|
signature_name |
否 |
String |
签名名称 |
signature_id |
否 |
String |
签名id |
signature_type |
否 |
String |
签名类型 |
app_name |
否 |
String |
应用名称 |
apply_desc |
否 |
String |
申请描述 |
channel_num |
否 |
String |
国内短信通道号，仅当签名审核成功，运营人员配置完成后返回。 |
review_desc |
否 |
String |
审核意见 |
file_id |
否 |
String |
文件id |
status |
否 |
String |
签名状态 |
site |
否 |
String |
地域，取值范围：cn及hk ，当前该参数暂时不使用 |
signature_source |
否 |
Integer |
签名来源 |
is_involved_third |
否 |
String |
是否涉及第三方权益 |
power_attorney_file_id |
否 |
String |
授权委托书文件ID |
urge_status |
否 |
String |
催审状态 |
urge_time |
否 |
String |
催审时间 |
urge_desc |
否 |
String |
催审描述 |
app_key |
否 |
String |
应用key |
source_title_content |
否 |
String |
签名来源 是否必填 取值 0 否 1 是 工信部备案网站域名，例如console.huaweicloud.com 2 是 APP应用下载地址 3 是 公众号或者小程序的全称 4 是 电商平台店铺地址 5 否 |
signature_usage |
否 |
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"
}
],
"total": 1
}
返回值
返回值 |
描述 |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
System error |
