Query USMS Signature Application Status - QueryUSMSSignature

Overview

Invoke the QueryUSMSSignature interface to query the status of the SMS signature application

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `QueryUSMSSignature`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.	No
SigId	string	Applied SMS Signature ID (Work Order ID when applying for SMS signature); At least one of the Signature ID and Signature must be filled in;	No
SigContent	string	Signature content; At least one of Signature ID and Signature must be filled in;	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
Data	OutSignature	Signature Information	Yes

Data Model

OutSignature

Field Name	Type	Description Information	Required
SigId	string	Signature ID	Yes
SigContent	string	Signature Content	Yes
Status	int	Signature status. 0-Pending review 1-Under review 2-Approved 3-Not approved 4-Disabled	Yes
ErrDesc	string	Signature Audit Failure Reason	Yes

Example

Request Example


https://api.ucloud-global.com/?Action=QueryUSMSSignature
&ProjectId=BLAfnnPS
&SigId=SIG20190711D48C1F

Response Example


{
  "Action": "QueryUSMSSignatureResponse",
  "Data": {
    "ErrDesc": "",
    "SigContent": "test",
    "SigId": "SIG20190711D48C1F",
    "Status": 2
  },
  "Message": "",
  "RetCode": 0
}