Obtaining Signature Details

Function

This API is used to query signature details.

URI

GET /v2/{project_id}/msgsms/signatures/{id}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Primary key ID of the signature. For details, see id in Table 5.
project_id	Yes	String	Project ID. For details, see Obtaining Account, User, and Project Information.

Request Parameters

**Table 2** 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 3** SmsSignatureResp response parameters
Parameter	Description
id	Primary key ID of 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/07cfacbb-d48c-4c4d-b3da-baa8e4664852 
Host: 100.85.***.***:30300
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
X-Auth-Token:******
Content-Length: 38
 
----WebKitFormBoundary7MA4YWxkTrZu0gW

Response Example

{
    "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": "******1-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"
}