CreateDigitalSignOrder

更新时间:
复制 MD 格式

Creates an order to add, update, or delete a digital message signature.

Operation description

Creates, updates, or deletes a signature.

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

OrderType

string

No

The operation to perform on the signature. Valid values:

  • UPDATE_DIGITALSMS_SIGN: Update a signature.

  • DELETE_DIGITALSMS_SIGN: Delete a signature.

  • CREATE_DIGITALSMS_SIGN: Create a signature.

Valid values:

  • UPDATE_DIGITALSMS_SIGN :

    Update

  • DELETE_DIGITALSMS_SIGN :

    Delete

  • CREATE_DIGITALSMS_SIGN :

    Create

CREATE_DIGITALSMS_SIGN

Submitter

string

No

The ID of the user who submits the order.

110000001750080

SignName

string

No

The signature name. This parameter is required for creating, updating, and deleting signatures.

  1. The name must be 2 to 16 characters in length.

  2. The name can contain Chinese characters, letters, and digits.

  • Special characters are not allowed, including $, &, %, #, @, !, ^, *, (, ), _, +, -, =, {, }, [, ], |, ;, :, ', ", <, >, ,, ., /, ?, ~, and .

  • The name cannot be only letters.

  • The name cannot be only digits. Spaces are not allowed.

  • Emojis are not allowed.

阿里云商城

QualificationId

integer

No

The ID of the qualification.

41

QualificationVersion

integer

No

The version of the qualification.

49

OrderContext

object

No

The qualification information. This object is required when you create a signature, or when you update a signature's qualification information.

  • qualificationCompanyName: Company name. The name can be up to 150 characters long. It cannot consist of only digits or contain symbols other than the middle dot (·), Chinese brackets (【】), Chinese parentheses (()), English parentheses (()), and spaces.

  • qualificationOrganizationCode: The 18-character Unified Social Credit Identifier (USCI). It must be an 18-digit code or a code that consists of 18 uppercase or lowercase letters and digits.

  • qualificationAdminName: The name of the agent or legal representative. The name must be in Chinese.

  • qualificationAdminIDCard: The 18-digit ID card number of the agent. Only PRC ID cards are supported.

  • qualificationLegalPersonName: The name of the legal representative or agent.

  • qualificationLegalPersonIDCard: The 18-digit ID card number of the legal representative. Only PRC ID cards are supported.

{ "qualificationCompanyName": "阿里阿巴", "qualificationOrganizationCode": "91330106MA2A0XABCD", "qualificationLegalPersonName": "张三", "qualificationLegalPersonIDCard": "110105199001011234", "qualificationAdminName": "李四", "qualificationAdminIDCard": "11010519900101****" }

SignIndustry

integer

No

The industry type. This parameter is required when you create or update a signature. It is optional when you delete a signature. Valid values:

  • 0: General (GENERAL)

  • 1: E-commerce and retail (ECOMMERCE)

Valid values:

  • 0 :

    General (GENERAL)

  • 1 :

    E-commerce and retail (ECOMMERCE)

0

SignId

integer

No

The unique ID of the signature.

80

SignSource

integer

No

The signature source. This parameter is required when you create or update a signature. It is optional when you delete a signature. Valid values:

  • 0: Enterprises and public institutions

  • 2: App

Valid values:

  • 0 :

    Enterprises and public institutions

  • 2 :

    App

  • 5 :

    Brand name

  • 7 :
    E-commerce or flagship store

0

ExtendMessage

string

No

Reserved for future use.

example

The qualification information. This object is required when you create a signature, or when you update a signature's qualification information.

Example in JSON format: { "qualificationCompanyName": "Aliaba", "qualificationOrganizationCode": "91330106MA2A0XABCD", "qualificationLegalPersonName": "Zhang San", "qualificationLegalPersonIDCard": "110105199001011234", "qualificationAdminName": "Li Si", "qualificationAdminIDCard": "1101051990010100000" }

  • qualificationCompanyName The name of the company. The only supported symbols are the middle dot (·), Chinese brackets (【】), Chinese parentheses (()), English parentheses (()), and spaces. The value cannot consist of only digits, and its length cannot exceed 150 characters.

  • qualificationOrganizationCode: The 18-character USCI. It must be an 18-digit code or a code that consists of 18 uppercase or lowercase letters and digits.

  • qualificationAdminName: The name of the agent or legal representative. The name must be in Chinese.

  • qualificationAdminIDCard: The 18-digit ID card number of the agent. Only PRC ID cards are supported.

  • qualificationLegalPersonName: The name of the legal representative or agent.

  • qualificationLegalPersonIDCard: The 18-digit ID card number of the legal representative. Only PRC ID cards are supported.

Response elements

Element

Type

Description

Example

object

The response object.

AccessDeniedDetail

string

The details about the access denial. This parameter is returned only if the RAM user is not authorized.

None

RequestId

string

The ID of the request.

2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069

Message

string

The returned message.

example

Data

object

The returned data.

  • signName: The name of the signature.

  • signOrderId: The ID of the signature order.

  • signCode: The code of the signature.

  • signId: The ID of the signature.

{'signId': '2006746****', 'signCode': 'SIGN_100000184736042_174416475****_hpMd1', 'signOrderId': 2246979****, 'signName': u'\u8d5b\u745e\u5a05\u808c\u80a4\u7ba1\u7406'}

Code

string

The status code.

  • If the request is successful, OK is returned.

  • For more information about other error codes, see API error codes.

OK

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

Valid values:

  • true :

    Success

  • false :

    Failure

true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069",
  "Message": "example",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.