Updated on 2023-09-08 GMT+08:00

Creating an SMS Signature

Function

This API is used to create a signature.

URI

POST /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.

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

app_id

Yes

String

Primary key ID of the application. For details, see id in Table 5.

apply_desc

No

String

Application description.

file_id

No

String

Business license file ID, which is the value of file_id in Table 5.

is_involved_third

Yes

String

Whether third-party rights and interests are involved.

  • yes
  • no

power_attorney_fileid

No

String

File ID of the power of attorney, which is the value of file_id in Table 5.

signature_name

Yes

String

Signature name.

signature_source

Yes

Integer

Signature source. Enumerated values:

  • 0: full name or abbreviation of an enterprise or public institution
  • 1: full name or abbreviation of a website archived by MIIT
  • 2: full name or abbreviation of an application
  • 3: full name or abbreviation of an applet or official account
  • 4: full name or abbreviation of a shop on an e-commerce platform
  • 5: full name or abbreviation of a trademark

signature_type

Yes

String

Signature type. Enumerated values:

  • VERIFY_CODE_TYPE: verification code
  • NOTIFY_TYPE: notification

source_title_content

No

String

Signature Source Mandatory Value

0 No

1 Yes Website licensed by the Ministry of Industry and Information Technology (MIIT), for example, console.huaweicloud.com

2 Yes App download address

3 Yes Full name of the official account or applet

4 Yes Store address on the e-commerce platform

5 No

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Primary key ID of the signature.

signature_id

String

Signature ID.

signature_name

String

Signature name.

Request Example

POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures 
Host: 100.85.***.***:30300
Content-Type: application/json
X-Auth-Token:******
Content-Length: 245
 
{
"app_id":"******9c-1a6b-4ee5-9651-5bca450694b3",
"apply_desc":"test",
"file_id":"******ab-1390-4268-9463-73db98cdc2e1",
"is_involved_third":"No",
"signature_name":"auto_test789",
"signature_source":"0",
"signature_type":"NOTIFY_TYPE"
}

Response Example

{
    "id": "******bb-d48c-4c4d-b3da-baa8e4664852",
    "signature_id": "******d1-196f-495f-abbe-42240469b8fc",
    "signature_name": "auto_test789"
}

Returned Values

Status Code

Description

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

500

System error