Version: V3.0

File Storage API

Get File Storage Config

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object	Body	Yes	Command parameter

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
ciphertext	String	Body	Ciphertext, dependent on SDK

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_file_storage_config",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {}
}

Success Return Example

Status Code: 200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ciphertext": "7b3d75f5a8cfa959167852468fca08a3"
  }
}

Failure Return Example

See Failure Return Example

Get Voice File Upload Permission

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	[]Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
filename	String	Body	Yes	Filename

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
ciphertext	String	Body	Ciphertext, dependent on SDK

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_voice_file_upload_permission",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "filename": "fc45e846ca23ab42c9ae469d988ae32a9"
    }
  ]
}

Success Return Example

Status Code: 200

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ciphertext": "7b3d75f5a8cfa959167852468fca08a3"
  }
}

Failure Return Example

See Failure Return Example

Get Face File Upload Permission

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	[]Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
filename	String	Body	Yes	Filename

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Type	Location	Location	Description
ciphertext	String	Body	Body	Ciphertext, dependent on SDK	Ciphertext, dependent on SDK

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_face_file_upload_permission",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "filename": "f45e846ca23ab42c9ae469d988ae32a96"
    }
  ]
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ciphertext": "7b3d75f5a8cfa959167852468fca08a3"
  }
}

Failure Return Example

See Failure Return Example

Get Maintenance File Upload Permission

Request URL

POST /api/v1.0/invoke/open-ability/method/user-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	[]Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
filename	String	Body	Yes	Filename

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Type	Location	Location	Description
ciphertext	String	Body	Body	Ciphertext, dependent on SDK	Ciphertext, dependent on SDK

Request Example

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_maintenance_file_upload_permission",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "filename": "fc45e846ca23ab42c9ae469d988ae32a9"
    }
  ]
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "ciphertext": "7b3d75f5a8cfa959167852468fca08a3"
  }
}

Failure Return Example

See Failure Return Example

Get File Storage Config​

Request URL​

Request Parameter​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Voice File Upload Permission​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Face File Upload Permission​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get Maintenance File Upload Permission​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get File Storage Config

Request URL

Request Parameter

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Voice File Upload Permission

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Face File Upload Permission

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get Maintenance File Upload Permission

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example