文档首页> 消息&短信 MSGSMS> API参考> API> 应用、签名、模板API> 短信签名API> 查询签名信息
更新时间：2024-01-17 GMT+08:00
查看PDF

查询签名信息

功能介绍

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

URI

GET /v2/{project_id}/msgsms/signatures

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，参考“获取账号、用户、项目的名称和ID”
表2 Query参数

参数

是否必选

参数类型

描述

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

排序方式

  • desc：降序
  • asc：升序

sort_key

否

String

排序字段，仅支持create_time

start_time

否

String

开始时间

status

否

String

状态

  • PENDING_REVIEW：待审核
  • PROCESSING：内容审核通过，签名处理中
  • REVIEW_PASSED：处理完毕
  • REVIEW_NOT_PASS：审核不通过
  • TO_BE_ACTIVATED：待激活
  • PENDING_ACTIVATE：激活审核中

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

results

Array of SmsSignatureResp

查询结果

total

Long

总数
表5 响应SmsSignatureResp参数

参数

描述

id

签名主键id，用于获取、修改、删除、申请激活签名的唯一标识

signature_name

签名名称

app_key

应用key

customer_id

租户customer id

signature_type

签名类型

signature_id

签名id

app_name

应用名称

signature_usage

签名用途

create_time

创建时间

apply_desc

申请描述

channel_num

中国大陆短信通道号，仅当签名审核成功，运营人员配置完成后返回。

file_id

文件id

status

状态

signature_source

签名来源

is_involved_third

是否涉及第三方权益

请求示例

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures?signature_name=auto_test789 HTTP/1.1
Host: 100.85.***.***:30300
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
X-Auth-Token:******
Content-Length: 38
 
----WebKitFormBoundary7MA4YWxkTrZu0gW

响应示例

{
    "results": [
        {
            "create_time": "2022-08-12 07:14:18",
            "customer_id": "******c55c3c4526b2ed7a0213bc9871",
            "tenant": {
                "customer_id": "******c55c3c4526b2ed7a0213bc9871",
                "customer_name": "****05",
                "enterprise_name": "华为技术有限公司"
            },
            "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",
            "app_key": "******3baZf4c856O4Qrbqvui3K2",
            "signature_usage": "COMMERCIAL"
        }
    ],
    "total": 1
}

返回值

返回值

描述

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error
父主题： 短信签名API