Querying Signature Information

Function

This API is used to query information about a created SMS signature.

URI

GET /v2/{project_id}/msgsms/signatures

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining Account, User, and Project Information.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
app_name	No	String	Application name.
end_time	No	String	End time.
limit	No	Integer	Quantity. The default value is 10.
offset	No	Integer	Offset.
signature_id	No	String	Signature ID.
signature_name	No	String	Signature name.
signature_type	No	String	Signature type.
site	No	String	Region. Options: cn and hk. Currently, this parameter is not in use.
sort_dir	No	String	Sorting method. desc: The query results are displayed in the descending order. asc: The query results are displayed in ascending order.
sort_key	No	String	Sorting field. Only create_time is supported.
start_time	No	String	Start time.
status	No	String	Status. PENDING_REVIEW: The signature is to be reviewed. PROCESSING: The content is approved and the signature is being processed. REVIEW_PASSED: The processing is complete. REVIEW_NOT_PASS: The signature is rejected. TO_BE_ACTIVATED: The signature is to be activated. PENDING_ACTIVATE: The activation is being reviewed.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Request body parameter type. This parameter must be set to application/json.
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
results	Array of SmsSignatureResp	Query result.
total	Long	Total number.

**Table 5** SmsSignatureResp response parameters
Parameter	Description
id	Primary key ID of the signature. It is unique and is used to obtain, modify, delete, and activate the signature.
signature_name	Signature name.
app_key	Application key.
customer_id	Customer ID.
signature_type	Signature type.
signature_id	Signature ID.
app_name	Application name.
signature_usage	Signature usage.
create_time	Creation time.
apply_desc	Application description.
channel_num	Channel number for the Chinese mainland SMS. This parameter is returned only when the signature is approved and the configuration is completed by the operations personnel.
file_id	File ID.
status	Status.
signature_source	Signature source.
is_involved_third	Whether third-party rights and interests are involved.

Request Example

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

Response Example

{
    "results": [
        {
            "create_time": "2022-08-12 07:14:18",
            "customer_id": "******c55c3c4526b2ed7a0213bc9871",
            "tenant": {
                "customer_id": "******c55c3c4526b2ed7a0213bc9871",
                "customer_name": "****05",
                "enterprise_name": "Huawei Technologies Co., Ltd."
            },
            "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
}