Image API | AppPush Developer Guide REST API

Image API

Last updated：16 days ago

Image API v4 provides image API functionality.

Call validation

For details, see the REST API Overview description of Authentication Method.

OPPO Image Upload

Call address

POST v4/image/oppo

              
              POST v4/image/oppo

This code block in the floating window

Request Example

Request Header

> POST /v4/image/oppo HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              > POST /v4/image/oppo HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

This code block in the floating window

Request Body

{ "big_picture_url" : "", "small_picture_url": "" }

              
              {
    "big_picture_url" : "",
    "small_picture_url": ""
}

This code block in the floating window

Request Parameters

Keyword	Type	Option	Meaning
big_picture_url	String	Optional	Large image URL OPPO requires size 984×369 px, file size within 1 MB, formats PNG/JPG/JPEG
small_picture_url	String	Optional	Small icon URL OPPO requires size 144×144 px, file size within 50 KB, formats PNG/JPG/JPEG

Return Parameters

Keyword	Type	Option	Meaning
big_picture_id	String	Optional	Large image id
small_picture_id	String	Optional	Small icon id

Return Example

Success

HTTP/1.1 200 OK Content-Type: application/json

              
              HTTP/1.1 200 OK
Content-Type: application/json

This code block in the floating window

{ "big_picture_id": "*******", "small_picture_id": "example_small_picture_id" }

              
              {
    "big_picture_id": "*******",
    "small_picture_id": "example_small_picture_id"
}

This code block in the floating window

The example IDs show the response structure only. Use the actual IDs returned by the upload API. If an ID is empty, its key is omitted rather than returned as an empty string.

Failure

{ "error": { "code": 21003, "message": "Parameter value is invalid" } }

              
              {
  "error": {
    "code": 21003,
    "message": "Parameter value is invalid"
  }
}

This code block in the floating window

Call returns

HTTP Status Code

Reference: HTTP-Status-Code

Error Code

Code	Description	Detailed Explanation	HTTP Status Code
0	success	Success	200
21001	Only support http POST request	Only HTTP POST requests are supported	405
21003	Parameter value is invalid	Invalid parameter value	400
23001	Basic authentication failed	HTTP Basic authorization failed	401
23002	Missing parameter!	Missing required parameter	400
23100	server error	Internal system error	400
27000	Server response time out, please try again later	Internal system error	500
51	Picture Size Exceeds	OPPO returned error. Generally the image exceeds the limit, please try another image	200