picture API

Overview

Function description

need to be combinedPush Android SDK v3.9.0Used in conjunction with versions above. Developers submit images or network resources URL toJiguangserver,JiguangIt will be adapted to various manufacturers according to the needs of developers. At the same time, developers will start fromJiguangGet the corresponding resourcesMediaID,ShouldMediaIDAvailable at Push API v3 Use it to achieve the need to push large pictures, large icons and small icons uniformly.

Calling address

https://api.jpush.cn/v3/images

Call verification

For details, see REST API Outlined Authentication method illustrate.

call limit

• Upload image size does not exceed 2M
• Pictures are saved for up to 30 days by default (from 2023-08-31 No. has been implemented, developers please pay attention)
  • Special note: One picture corresponds to one picture resourcemedia_id
• API Request frequency limit and Push API v3 Interface sharing

Support and requirements for each channel

1. The manufacturer channels that this interface can adapt to include:Jiguang、OPPO, Huawei, Honor andFCM；
2. Xiaomi from 2023.08 Starting from the beginning, the official no longer supports the function of dynamically setting small icons, right icons, and large pictures when pushing on new devices/systems. Historical devices and applications are also gradually covered, which means that the functions of dynamically setting small icons, right icons, and large pictures when pushing are no longer supported;
3. Currently, this interface does not provide file storage services, so please ensure that the image resources submitted are accessible and meet the requirements;
4. Different channels have different support for different types of pictures, as shown in the following table:

   	Jiguangaisle	Millet	OPPO	Huawei	glory	FCM
   big picture	1. supporthttp 2. supporthttps 3. Supports local resource paths and must besdcardrelative path, you need to specify the file suffix	-	1. supporthttp 2. supporthttps	-	-	1. supporthttp 2. supporthttps 3. Supports local resource paths and must besdcardrelative path, you need to specify the file suffix
   big icon	1. supporthttp 2. supporthttps 3. Support is located atdrawableThe icon path of the resource folder, no need to specify the file suffix	-	1. supporthttp 2. supporthttps	1. supporthttps	1. supporthttps	1. supporthttp 2. supporthttps 3. Support is located atdrawableThe icon path of the resource folder, no need to specify the file suffix
   small icon	1. supporthttp 2. supporthttps 3. Support is located atdrawableThe icon path of the resource folder, no need to specify the file suffix	-	-	1. Supports local resource paths and must be submitted with /raw/ The path at the beginning, no need to specify the file suffix	1. Supports local resource paths and must be submitted with /raw/ The path at the beginning, no need to specify the file suffix	-

**Note: The above are only supported jpg 、 jpeg as well as png format resources. **

Add a new picture (URLWay)

Calling address

POST https://api.jpush.cn/v3/images/byurls

Function description

By specifying network image resourcesURLto add an adaptation in the form

Call example

Request Header

          > POST /v3/images/byurls HTTP/1.1
> Content-Type: application/json
> Authorization: Basic MjhhMTBjMDkwNGI1Y2Q2MjJhYWRhZWIxOmU5ZmFhMmM5NzYzZGViZDIwZTdkZTFlYg==

        

Request data

          {
    "image_type": 2,
    "image_url": "https://xx.com/xx.jpg",
    "oppo_image_url": "https://xx.com/oppo.jpg",
    "xiaomi_image_url": "https://xx.com/xiaomi.jpg",
    "huawei_image_url": "",
    "honor_image_url": "",
    "fcm_image_url": "",
    "jiguang_image_url": "https://xx.com/jiguang.jpg",
    "hmos_image_url": "https://xx.com/hmos.jpg"     // 20240813新增，适配鸿蒙上传图片
}

        

The complete parameter description is as follows:

Remark:

1. image_urlAnd the field values ​​of each channel cannot be empty at the same time;
2. The specified manufacturer image field will only be processed if the manufacturer supports the corresponding image type; if the large image address of the Huawei manufacturer is configured, since the Huawei manufacturer does not support the large image type, the Huawei field in the result will be null.

Return example

Return successfully

          HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Success Response Data
{
    "media_id": "jgmedia-2-14b23451-0001-41ce-89d9-987b465122da",   // 得到的结果 media_id ，推送时可将该id作为参数传递给 Push 推送接口，具体见参考
    "oppo_image_url": "3653918_5f92b5739ae676f5745bcbf4",   // 适配 OPPO 要求后 OPPO 响应得到的 id
    "xiaomi_image_url": "http://f6.market.xiaomi.com/download/MiPass/01fff50f50ba193f94074ec/d1671936d468383f.png",     // 适配小米要求后小米响应得到的图标地址，小2023.08 开始不再支持
    "huawei_image_url": "https://xx.com/xx.jpg",    // 配置的华为图标地址
    "honor_image_url": "https://xx.com/xx.jpg",    // 配置的荣耀图标地址
    "fcm_image_url": "https://xx.com/xx.jpg",   // 配置的FCM图标地址
    "jiguang_image_url": "https://xx.com/jiguang.jpg",   // 配置的极光通道的图标地址
    "hmos_image_url": "https://xx.com/xx.jpg"    // 配置的鸿蒙图标地址，20240813新增
}

        

return on failure

          HTTP/1.1 400 OK
Content-Type: application/json; charset=utf-8

Failed Response Data
{
    "error": {
        "code": 1002,
        "message": "Missing authen info."
    }
}

        

Add image (file method)

Calling address

POST https://api.jpush.cn/v3/images/byfiles

Function description

Add an adaptation by uploading an image file. This interface currently only supports Xiaomi and OPPO 。

**Note:**Xiaomi from 2023.08 Initially, the official no longer supports the function of dynamically setting small icons, right icons, and large pictures when pushing on new devices/systems. Historical devices and applications are also gradually being covered, which means that the functions of dynamically setting small icons, right icons, and large pictures when pushing are no longer supported.

Call example

          curl  --request POST 'https://api.jpush.cn/v3/images/byfiles' --header 'Content-Type: multipart/form-data' --header 'Authorization: Basic MjhhMTBjMDkwNGI1Y2Q2MjJhYWRhZWIxOmU5ZmFhMmM5NzYzZGViZDIwZTdkZTFlYg=='  --form 'xiaomi_file=@/home/user/pictures/test_file1.jpg'  --form 'oppo_file=@/home/user/pictures/test_file2.jpg' --form 'image_type=1'

        

The complete parameter description is as follows:

**Remark:oppo_fileandxiaomi_filecannot be empty at the same time. **

Return example

Return successfully

          HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Success Response Data
{
    "media_id": "jgmedia-1-6d98e85f-d3a5-412a-bdec-de1b75bd3ad3",   // 得到的结果 media_id ，推送时可将该id作为参数传递给 Push 推送接口，具体见参考
    "oppo_image_url": "3653918_5f92b5739ae676f5745bcbf4",   // 适配 OPPO 要求后 OPPO 响应得到的 id
    "xiaomi_image_url": "http://f6.market.xiaomi.com/download/MiPass/01fff50f50ba193f94074ec/d1671936d468383f.png",     // 适配小米要求后小米响应得到的图标地址
    "huawei_image_url": "",
    "honor_image_url": "",
    "fcm_image_url": "",
    "jiguang_image_url": ""
}

        

return on failure

          HTTP/1.1 400 OK
Content-Type: application/json; charset=utf-8

Failed Response Data
{
    "error": {
        "code": 1002,
        "message": "Missing authen info."
    }
}

        

Update picture (URLWay)

Calling address

PUT https://api.jpush.cn/v3/images/byurls/{mediaId}

Function description

By specifying network image resourcesURLform to modify/update the adaptation results

Call example

Request Header

          > PUT /v3/images/byurls/jgmedia-2-14b23451-0001-41ce-89d9-987b465122da HTTP/1.1
> Content-Type: application/json
> Authorization: Basic MjhhMTBjMDkwNGI1Y2Q2MjJhYWRhZWIxOmU5ZmFhMmM5NzYzZGViZDIwZTdkZTFlYg==

        

Request data

          {
    "oppo_image_url": "",
    "xiaomi_image_url": "",
    "huawei_image_url": "https://xx.com/new_huawei.jpg",
    "honor_image_url": "https://xx.com/new_honor.jpg",
    "fcm_image_url": "",
    "jiguang_image_url": "http://xx.com/new_jiguang.jpg",
    "hmos_image_url": "https://xx.com/hmos.jpg"     // 适配鸿蒙更新图片，20240813新增
}

        

The complete parameter description is as follows:

Remark:

1. The field values ​​of each channel cannot be empty at the same time;
2. If the manufacturer address of the updated configuration is not specified, the configuration result of the manufacturer retains the value before the update and will not be left blank;
3. If the manufacturer that specifies the updated configuration does not support the corresponding type, the configuration results of that manufacturer will retain the values ​​before the update and will not be overwritten.

Return example

Return successfully

          HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Success Response Data
{
    "media_id": "jgmedia-2-14b23451-0001-41ce-89d9-987b465122da",   // 更新的 media_id ，推送时可将该id作为参数传递给 Push 推送接口，具体见参考
    "oppo_image_url": "3653918_5f92b5739ae676f5745bcbf4",   // 适配 OPPO 要求后 OPPO 响应得到的 id
    "xiaomi_image_url": "http://f6.market.xiaomi.com/download/MiPass/01fff50f50ba193f94074ec/d1671936d468383f.png",     // 适配小米要求后小米响应得到的图标地址
    "huawei_image_url": "https://xx.com/new_huawei.jpg",    // 配置的华为图标地址
    "honor_image_url": "https://xx.com/new_honor.jpg",    // 配置的荣耀图标地址
    "fcm_image_url": "https://xx.com/xx.jpg",   // 配置的FCM图标地址
    "jiguang_image_url": "http://xx.com/new_jiguang.jpg",   // 配置的极光通道的图标地址
    "hmos_image_url": "http://xx.com/new_hmos.jpg"   // 配置的鸿蒙通道的图标地址，20240813新增
}

        

return on failure

          HTTP/1.1 400 OK
Content-Type: application/json; charset=utf-8

Failed Response Data
{
    "error": {
        "code": 1002,
        "message": "Missing authen info."
    }
}

        

Update picture (file method)

Calling address

PUT https://api.jpush.cn/v3/images/byfiles/{mediaId}

Function description

Modify/update the adaptation results by uploading image files. This interface currently only supportsOPPO

**Note:**Xiaomi from 2023.08 Initially, the official no longer supports the function of dynamically setting small icons, right icons, and large pictures when pushing on new devices/systems. Historical devices and applications are also gradually being covered, which means that the functions of dynamically setting small icons, right icons, and large pictures when pushing are no longer supported.

Call example

          curl  --request PUT 'https://api.jpush.cn/v3/images/byfiles/jgmedia-1-6d98e85f-d3a5-412a-bdec-de1b75bd3ad3' --header 'Content-Type: multipart/form-data' --header 'Authorization: Basic MjhhMTBjMDkwNGI1Y2Q2MjJhYWRhZWIxOmU5ZmFhMmM5NzYzZGViZDIwZTdkZTFlYg=='  --form 'xiaomi_file=@/home/user/pictures/test_file1.jpg'  --form 'oppo_file=@/home/user/pictures/test_file2.jpg'

        

The complete parameter description is as follows:

Remark:oppo_fileandxiaomi_fileCannot be empty at the same time

Return example

Return successfully

          HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Success Response Data
{
    "media_id": "jgmedia-1-6d98e85f-d3a5-412a-bdec-de1b75bd3ad3",   // 更新的 media_id ，推送时可将该id作为参数传递给 Push 推送接口，具体见参考
    "oppo_image_url": "3653918_3_5f9a5f7cb3c87bf699b332a5",   // 适配 OPPO 要求后 OPPO 响应得到的 id
    "xiaomi_image_url": "http://f8.market.xiaomi.com/download/MiPass/0dfdb5eba1bbb8d1671983fdb2be94074ec/8a350da36d46835768f17f48a6b12b2765cec115.png",     // 适配小米要求后小米响应得到的图标地址
    "huawei_image_url": "",
    "honor_image_url": "",
    "fcm_image_url": "",
    "jiguang_image_url": ""
}

        

return on failure

          HTTP/1.1 400 OK
Content-Type: application/json; charset=utf-8

Failed Response Data
{
    "error": {
        "code": 1002,
        "message": "Missing authen info."
    }
}

        

Status code description

refer to

• HTTP Return code:HTTP-Status-Code
• HTTP Specification reference:HTTP basic authentication
• PushPush API：Push API v3
• OPPOPicture requirements:OPPO-Image upload
• Picture description of Huawei's downstream news:Huawei - Downward news
• Honor message picture description:glory API Access document