Updated on 2022-12-29 GMT+08:00

Querying an Application File

Function

This API is used to query information about the uploaded file.

URI

GET /v2/{project_id}/msgsms/upload-files

Table 1 URI parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining Account, User, and Project Information.

Table 2 Query parameter

Parameter

Mandatory

Type

Description

file_id

Yes

String

Business license ID.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

file_desc

String

File description.

file_id

String

File ID.

file_name

String

File name.

file_ref

Integer

File reference.

file_size

Long

File size.

file_type

Integer

File type.

module_type

Integer

Module type.

operator

String

Operator.

update_time

String

Update time.

Request Example

GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/upload-files?file_id=057a76ab-1390-4268-9463-73db98cdc2e1 
Host: 100.85.***.***:30300
Content-Type: multipart/form-data; boundary=<calculated when request is sent>
X-Auth-Token:******X

Response Example

{
    "file_id": "******ab-1390-4268-9463-73db98cdc2e1",
    "module_type": 2,
    "operator": "******c55c3c4526b2ed7a0213bc9871",
    "file_type": 1,
    "file_name": "test.PNG",
    "file_size": 327,
    "file_ref": 1,
    "update_time": "2022-08-12 07:13:24"
}

Returned Values

Status Code

Description

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

500

System error