v2.push.get_app_push_config
GET /api/v2/push/get_app_push_config
you can get your app current push config setting through this api
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/push/get_app_push_config
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
No Request Parameters Set.
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| request_id | string | b937c04e554847789cbf3fe33a0ad5f1 | The identifier for an API request for error tracking. |
| error | string | common.error_auth | Indicate error type if hit error. Empty if no error happened. |
| message | string | Invalid sign | Indicate error details if hit error. Empty if no error happened. |
| response | object | Detail informations you are querying. | |
| callback_url | string | https://open.shopee.com/ | The callback url of push mechanism. It is the address where the Shopee will send the push message to. If you don't set any callback_url before, this parameters is required. |
| live_push_status | string | suspended | live push status:Normal,Warning,Suspended |
| suspended_time | timestamp | 1577416181 | The live push suspended time caused by low successful rate of push mechanism.Only when live push status is suspended, this parameters will response. |
| blocked_shop_id | int[] | [10010,20020,30030] | Use this filed to indicate that Shopee won't send any push message created by this shop. |
| push_config_on_list | int[] | [1,2,3] | Use this field to indicate which push config turn on, and you can receive the push message. 1=Shop authorization for partners 2=Shop deauthorization for partners 3=Order status update push 4=TrackingNo push 5=Shopee Updates 6=Banned item push 7=item promotion push 8=reserved stock change push 9=promotionn update push 10=webchat push 11=video upload push 12=openapi authorization expiry push 13=brand register result |
| push_config_off_list | int[] | [4,5,6,7,8,9,10,11,12,13] | Use this field to indicate which push config turn on, and you can receive the push message. 1=Shop authorization for partners 2=Shop deauthorization for partners 3=Order status update push 4=TrackingNo push 5=Shopee Updates 6=Banned item push 7=item promotion push 8=reserved stock change push 9=promotionn update push 10=webchat push 11=video upload push 12=openapi authorization expiry push 13=brand register result |