QueryDigitalSignByName-阿里云帮助中心

Operation description

You can query only the digital SMS signatures that belong to your Alibaba Cloud account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SignName	string	No	The name of the digital SMS signature. The signature must belong to your Alibaba Cloud account.	阿里云数字商城

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details of the access denial. This parameter is returned only if Resource Access Management (RAM) authentication fails.	无
RequestId	string	The ID of the request.	F655A8D5-B967-440B-8683-DAD6FF8DE990
Message	string	The description of the status code.	OK
Data	object	`gmtModified`: The time when the signature was last modified. `creator`: The ID of the user who created the signature. `signName`: The name of the digital SMS signature. `qualificationId`: The ID of the qualification. You can create qualifications in the console or by calling an API operation. `signIndustry`: The industry type. Valid values: `0` (General) and `1` (E-commerce). `signVersion`: The version of the signature. This value is updated for each new version. The current version is 1. `telecomRegisterStatus`: The filing status with China Telecom. Valid values: `0` (Filing Failed), `3` (Filing Successful), `-1` (Filing in Progress), and `-2` (Not Filed). `signCode`: The code of the digital SMS signature. `gmtCreate`: The time when the signature was created. `signId`: The ID of the signature. This is a unique identifier. `mobileRegisterStatus`: The filing status with China Mobile. `SignSource`: The source of the signature. Valid values: `mobileAvailableStatus`: The availability status with China Mobile. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message. `unicomRegisterStatus`: The filing status with China Unicom. Valid values: `0` (Filing Failed), `3` (Filing Successful), `-1` (Filing in Progress), and `-2` (Not Filed). `unicomAvailableStatus`: The availability status with China Unicom. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message. `telecomAvailableStatus`: The availability status with China Telecom. Valid values: `0` (Unavailable) and `1` (Available). We recommend that you select an available signature when you create a template or send a digital SMS message.	"Data": { "gmtModified": 1770005896000, "creator": "UID:1498275912899720", "signName": "驳回理由", "qualificationId": 2757722, "qualificationVersion": 1768974751432, "signIndustry": 0, "registerStatueReason": {}, "signVersion": 1, "remark": "", "telecomRegisterStatus": -1, "signCode": "DIGSIGN_100000168688001_1769050485148_pYZu1", "gmtCreate": 1769050485000, "signId": 22784769, "mobileRegisterStatus": -1, "signSource": 0, "mobileAvailableStatus": 0, "attachmentList": [], "unicomRegisterStatus": 3, "unicomAvailableStatus": 1, "signType": 1, "telecomAvailableStatus": 0, "extendMessage": "{}" },
Code	string	The status code of the request. A value of `OK` indicates that the request was successful. Other values indicate error codes.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true : The request was successful. false : The request failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "无",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "Message": "OK",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.