{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-push/bind-alias":{"post":{"operationId":"cloud_aliyun_push_bind_alias","summary":"Attach an alias to a device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId","AliasName"],"properties":{"AppKey":{"type":"integer","description":"Your AppKey"},"DeviceId":{"type":"string","description":"The unique identifier of the device in Mobile Push. It is 32 characters long and contains only numbers and lowercase letters"},"AliasName":{"type":"string","description":"The alias to attach. You can attach up to 10 aliases in one request. Separate multiple aliases with commas. Each alias can be up to 128…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/bind-phone":{"post":{"operationId":"cloud_aliyun_push_bind_phone","summary":"Attaches a device to a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId","PhoneNumber"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"DeviceId":{"type":"string","description":"The unique identity of the device, 32-bit, a combination of numbers and lowercase letters"},"PhoneNumber":{"type":"string","description":"Phone number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/bind-tag":{"post":{"operationId":"cloud_aliyun_push_bind_tag","summary":"Binds tags to specified device targets. Tag bindings take effect within 10 minutes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","ClientKey","KeyType","TagName"],"properties":{"AppKey":{"type":"integer","description":"The AppKey of your application"},"ClientKey":{"type":"string","description":"The ID of the target device. You can specify a maximum of 1,000 device IDs"},"KeyType":{"type":"string","enum":["DEVICE","ACCOUNT","ALIAS"],"description":"The type of the `ClientKey`. Valid value: DEVICE: Indicates a device target"},"TagName":{"type":"string","description":"The tags to bind. Separate multiple tags with commas (,). You can bind up to 10 tags per request. A tag name can be up to 128 characters…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/cancel-push":{"post":{"operationId":"cloud_aliyun_push_cancel_push","summary":"Cancels a scheduled push task that has not yet been executed","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","MessageId"],"properties":{"AppKey":{"type":"integer","description":"Your AppKey"},"MessageId":{"type":"integer","description":"The message ID of the push task to cancel"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/check-certificate":{"post":{"operationId":"cloud_aliyun_push_check_certificate","summary":"Checks the expiration time and current status of the iOS certificate for a specified app","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey"],"properties":{"AppKey":{"type":"integer","description":"The AppKey of the application"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/check-devices":{"post":{"operationId":"cloud_aliyun_push_check_devices","summary":"Validate a specified group of devices","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceIds"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"DeviceIds":{"type":"string","description":"The unique identifier for each device in the push service. Each ID is 32 characters long and contains only digits and lowercase letters.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/complete-continuously-push":{"post":{"operationId":"cloud_aliyun_push_complete_continuously_push","summary":"Manually ends a continuous push task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","MessageId"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"MessageId":{"type":"string","description":"The message ID. This ID is returned after you call the Push operation and set Target to TBD. It identifies a message saved in the push…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/continuously-push":{"post":{"operationId":"cloud_aliyun_push_continuously_push","summary":"Executes a predefined continuous push task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","MessageId","Target","TargetValue"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"MessageId":{"type":"string","description":"Message ID. Obtain this MessageId by calling the Push API with Target set to TBD. It represents a message already saved in the push system"},"Target":{"type":"string","enum":["DEVICE","ACCOUNT","ALIAS"],"description":"Push target: DEVICE: Push by device ACCOUNT: Push by account ALIAS: Push by alias Continuous push supports only these three target types"},"TargetValue":{"type":"string","description":"Specify values based on Target. Separate multiple values with commas. If you exceed the limit, split the push into multiple calls.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/list-tags":{"post":{"operationId":"cloud_aliyun_push_list_tags","summary":"Queries the tags of an app. A maximum of 100 records are returned","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/mass-push":{"post":{"operationId":"cloud_aliyun_push_mass_push","summary":"Push different messages/notifications to different devices in batch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","PushTask"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"PushTask":{"type":"string","description":"An array of independent push tasks (JSON-encoded)"},"IdempotentToken":{"type":"string","description":"An idempotency parameter used to prevent duplicate pushes caused by API caller retries. When calls are made with the same IdempotentToken…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/mass-push-v2":{"post":{"operationId":"cloud_aliyun_push_mass_push_v2","summary":"Pushes notifications in batch by using the advanced push API V2","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","PushTasks"],"properties":{"AppKey":{"type":"integer","description":"The AppKey information"},"IdempotentToken":{"type":"string","description":"An idempotent parameter used to prevent duplicate pushes caused by API call retries on the client side. If the same IdempotentToken is…"},"PushTasks":{"type":"string","description":"The batch push tasks (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push":{"post":{"operationId":"cloud_aliyun_push_push","summary":"Advanced Push API that pushes notifications or messages to different device endpoints. This API provides…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","PushType","DeviceType","Target","TargetValue"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"PushType":{"type":"string","enum":["MESSAGE","NOTICE"],"description":"Push type. Valid values: NOTICE: Notification. Notifications are delivered to devices through vendor channels such as APNs, Huawei,…"},"DeviceType":{"type":"string","enum":["iOS","ANDROID","ALL","HARMONY"],"description":"Device type. Valid values: HARMONY: HarmonyOS device iOS: iOS device ANDROID: Android device ALL: When the AppKey is for a legacy…"},"Target":{"type":"string","enum":["ALL","DEVICE","ACCOUNT","ALIAS","TAG","TBD","FILE"],"description":"Push target. Valid values: DEVICE: Push by device. ACCOUNT: Push by account. ALIAS: Push by alias. TAG: Push by tag. ALL: Push to all…"},"TargetValue":{"type":"string","description":"Set based on the Target type. Multiple values are separated by commas. If the limit is exceeded, split into multiple pushes.…"},"StoreOffline":{"type":"string","description":"Whether to store offline messages/notifications. StoreOffline defaults to false. If enabled, when the user is offline during push, the…"},"SendChannels":{"type":"string","description":"Specify sending channels. Valid values: accs: Alibaba Cloud proprietary channel huawei: Huawei channel honor: Honor channel xiaomi: Xiaomi…"},"PushTime":{"type":"string","description":"Used for scheduled sending. If not set, the default is immediate sending. Scheduled sending must be no later than 7 days from now. The…"},"ExpireTime":{"type":"string","description":"Expiration time for offline messages/notifications, used in conjunction with StoreOffline. Expired messages will no longer be sent.…"},"JobKey":{"type":"string","description":"Custom identifier for the push task. When JobKey is not empty, the receipt log will include this field. For viewing receipt logs, see…"},"Title":{"type":"string","description":"Title of the notification/message during push. Length limit: 200 bytes. Required for Android and HarmonyOS push; optional for iOS…"},"Body":{"type":"string","description":"Notification content/message content for Android and HarmonyOS push; iOS message/notification content. The push content size is limited.…"},"Trim":{"type":"string","description":"Whether to automatically truncate overly long titles and content. Only applies to vendor channels that explicitly limit title and content…"},"iOSApnsEnv":{"type":"string","enum":["PRODUCT","DEV"],"description":"iOS notifications are sent through the APNs center, and the corresponding environment information must be provided. DEV: Development…"},"iOSRemind":{"type":"string","description":"When the device is offline during message push (i.e., the persistent connection to the push server is disconnected), this push will be…"},"iOSSubtitle":{"type":"string","description":"iOS notification subtitle content (iOS 10+)"},"iOSRemindBody":{"type":"string","description":"iOS notification content used when converting iOS messages to notifications. Only valid when iOSApnsEnv=PRODUCT and iOSRemind is true"},"iOSMusic":{"type":"string","description":"iOS notification sound. Specify the name of an audio file stored in the app bundle or the sandbox Library/Sounds directory. See:…"},"iOSBadge":{"type":"integer","description":"iOS app icon badge number in the upper-right corner. If iOSBadgeAutoIncrement is set to True, this field must be empty"},"iOSBadgeAutoIncrement":{"type":"string","description":"Whether to enable badge auto-increment. Default is false. When this is set to true, iOSBadge must be empty. The badge auto-increment…"},"iOSSilentNotification":{"type":"string","description":"Whether to enable iOS silent notification"},"iOSMutableContent":{"type":"string","description":"iOS notification processing extension flag (iOS 10+). If set to true, the APNs push notification can reach the Extension for processing…"},"iOSNotificationCategory":{"type":"string","description":"Specify the iOS notification Category (iOS 10+)"},"iOSNotificationCollapseId":{"type":"string","description":"When a device receives messages with the same CollapseId, they will be merged into one. When the device is offline and consecutive…"},"iOSNotificationThreadId":{"type":"string","description":"This attribute is used to group iOS remote notifications, identifying the group name for collapsed notifications. Only supported on iOS…"},"iOSInterruptionLevel":{"type":"string","description":"Interruption level. Valid values: passive: The system adds the notification to the notification list without lighting up the screen or…"},"iOSRelevanceScore":{"type":"number","description":"Summary highlight score. Value range: floating-point number in [0,1]"},"iOSExtParameters":{"type":"string","description":"Extension attributes for iOS notifications. For iOS 10+, you can specify the resource URL for rich media push notifications here:…"},"iOSLiveActivityEvent":{"type":"string","enum":["start","update","end"],"description":"Start, update, or end a Live Activity. Enum: start | update | end"},"iOSLiveActivityId":{"type":"string","description":"The Live Activity ID reported from the device to the user's server. The unique identifier of the Live Activity"},"iOSLiveActivityAttributesType":{"type":"string","description":"The type of Live Activity to start. Required when iOSLiveActivityEvent is start"},"iOSLiveActivityAttributes":{"type":"string","description":"JSON string, static parameters for Live Activity (Dynamic Island) push. Contains static user-defined information such as product IDs and…"},"iOSLiveActivityContentState":{"type":"string","description":"Dynamic parameters for Live Activity (Dynamic Island) push, containing real-time update information such as price and inventory changes"},"iOSLiveActivityDismissalDate":{"type":"integer","description":"Timestamp in seconds. The ended Live Activity will remain on the lock screen until this specified time, with a maximum of 4 hours"},"iOSLiveActivityStaleDate":{"type":"integer","description":"Timestamp in seconds. Marks the expiration time of the activity content"},"AndroidNotifyType":{"type":"string","enum":["NONE","VIBRATE","SOUND","BOTH"],"description":"Notification alert type. Valid values: VIBRATE: Vibration (default) SOUND: Sound BOTH: Sound and vibration NONE: Silent"},"AndroidRemind":{"type":"string","description":"When the push type is message and the device is offline, this push will use the supplementary popup feature. Default is false. Only…"},"AndroidOpenType":{"type":"string","enum":["APPLICATION","ACTIVITY","URL","NONE"],"description":"Action after clicking the notification. Valid values: APPLICATION: Open the application (default) ACTIVITY: Open an Android Activity URL:…"},"AndroidActivity":{"type":"string","description":"Specify the activity to open from the notification. Only pass this when AndroidOpenType=\"Activity\", e.g.:…"},"AndroidOpenUrl":{"type":"string","description":"URL to open when Android receives the push. Only pass this when AndroidOpenType=\"URL\""},"AndroidPopupActivity":{"type":"string","description":"Specify the Activity to navigate to after clicking the notification"},"AndroidPopupTitle":{"type":"string","description":"Title content in supplementary popup mode. Required when the AndroidPopupActivity parameter is not empty. Length limit: 50 characters…"},"AndroidPopupBody":{"type":"string","description":"Body content in supplementary popup mode. Required when the AndroidPopupActivity parameter is not empty. Length limit: 200 characters…"},"AndroidRenderStyle":{"type":"integer","description":"Notification style. Valid values: 0: Standard mode (default) 1: Long text mode (supported by Huawei, Honor, Xiaomi, OPPO, Meizu, and…"},"AndroidBigTitle":{"type":"string","description":"Title in long text mode. Length limit: 200 bytes (1 Chinese character counts as 3 bytes). Currently only supported by the Honor channel…"},"AndroidBigBody":{"type":"string","description":"Body in long text mode. Length limit: 1000 bytes (1 Chinese character counts as 3 bytes). Subject to specific vendor channel limits when…"},"AndroidBigPictureUrl":{"type":"string","description":"Image URL in big picture mode. Currently supported by: Proprietary channel: Android SDK 3.6.0 and above"},"AndroidXiaomiBigPictureUrl":{"type":"string","description":"This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports dynamically setting small icons, right-side…"},"AndroidImageUrl":{"type":"string","description":"Right-side icon URL. Currently supported by: Huawei EMUI (only applicable in long text mode and Inbox mode). Honor Magic UI (only…"},"AndroidXiaomiImageUrl":{"type":"string","description":"This parameter is deprecated. Starting from August 2023, Xiaomi officially no longer supports dynamically setting small icons, right-side…"},"AndroidInboxBody":{"type":"string","description":"Body content in Inbox mode. The content must be a valid JSON Array with no more than 5 elements. Currently supported by: Huawei: EMUI 9…"},"AndroidNotificationBarType":{"type":"integer","description":"Android custom notification bar style. Value range: 1-100"},"AndroidNotificationBarPriority":{"type":"integer","description":"Priority of the Android notification position in the notification bar. Valid values: -2, -1, 0, 1, 2"},"AndroidNotificationNotifyId":{"type":"integer","description":"Unique identifier for each message when displayed in the notification bar. Different notification bar messages can share the same…"},"AndroidNotificationChannel":{"type":"string","description":"The channelId of the Android app, which must correspond to the channelId in the app. Set the NotificationChannel parameter. For specific…"},"AndroidNotificationHuaweiChannel":{"type":"string","description":"Set the Huawei notification message classification importance parameter, which determines notification behavior on user devices. Valid…"},"AndroidNotificationHonorChannel":{"type":"string","description":"Set the Honor notification message classification importance parameter, which determines notification behavior on user devices. Valid…"},"AndroidNotificationXiaomiChannel":{"type":"string","description":"Set the Xiaomi notification type channelId. Requires application on the Xiaomi platform. For details, see: Application Link…"},"AndroidNotificationVivoChannel":{"type":"string","description":"Set the vivo notification message classification. Valid values: 0: Operational messages (default) 1: System messages vivo channel…"},"AndroidNotificationGroup":{"type":"string","description":"Message grouping. Messages in the same group are displayed as only the latest one in the notification bar along with the total count of…"},"AndroidNotificationThreadId":{"type":"string","description":"Message grouping. Messages in the same group are collapsed in the notification bar and can be expanded. Notifications from different…"},"AndroidExtParameters":{"type":"string","description":"Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE. This parameter must…"},"AndroidMessageHuaweiUrgency":{"type":"string","description":"Huawei channel notification delivery priority. Valid values: HIGH NORMAL Requires permission application. For details, see: Application…"},"AndroidMessageHuaweiCategory":{"type":"string","description":"Purpose 1: After completing the self-classification rights application…"},"AndroidMessageOppoCategory":{"type":"string","description":"OPPO classifies messages into two categories for management: Communication & Service, and Content & Marketing. Communication & Service…"},"AndroidMessageOppoNotifyLevel":{"type":"integer","description":"OPPO channel notification bar message notification level. Valid values: 1: Notification bar 2: Notification bar, lock screen, ringtone,…"},"AndroidMessageVivoCategory":{"type":"string","description":"vivo classifies messages into two categories for management: System messages and Operational messages. System messages: IM: Instant…"},"AndroidTargetUserType":{"type":"integer","enum":["0","1"],"description":"Set vendor channel notification type: 0: Official notification (default). 1: Test notification. When this parameter is configured, it is…"},"AndroidHuaweiTargetUserType":{"type":"integer","enum":["0","1"],"description":"Set Huawei channel notification type: 0: Official notification (default). 1: Test notification. Each application can send up to 500 test…"},"AndroidHonorTargetUserType":{"type":"integer","enum":["0","1"],"description":"Set Honor channel notification type: 0: Official notification (default). 1: Test notification. Each application can send up to 1000 test…"},"AndroidVivoPushMode":{"type":"integer","enum":["0","1"],"description":"Set vivo channel notification type: 0: Official push (default). 1: Test push. For test push, please configure the test device on the vivo…"},"AndroidOppoIntentEnv":{"type":"integer","enum":["0","1"],"description":"Set OPPO Fluid Cloud push environment: 0: Production environment (default). 1: Test environment. OPPO Fluid Cloud test environment…"},"AndroidHuaweiBusinessType":{"type":"integer","enum":["0","1"],"description":"Set Huawei Quick Notification parameter: 0: Send Huawei standard notification (default). 1: Send Huawei Quick Notification"},"AndroidHuaweiReceiptId":{"type":"string","description":"Huawei channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the Huawei channel push management…"},"AndroidVivoReceiptId":{"type":"string","description":"vivo channel receipt ID. This receipt ID can be found in the application information of the push service on the vivo open platform. If the…"},"AndroidBadgeClass":{"type":"string","description":"Full class name of the app entry Activity for badge settings. Only effective for Huawei/Honor vendor channel push"},"AndroidBadgeAddNum":{"type":"integer","description":"Set the badge increment value, which is added to the current badge count. Value range: [1-99]. Only effective for Huawei/Honor vendor…"},"AndroidBadgeSetNum":{"type":"integer","description":"Set a fixed badge number. Value range: [0-99]. For vendor channel push, only effective on Huawei and Honor channels. For Alibaba Cloud…"},"AndroidMusic":{"type":"string","description":"Huawei vendor channel notification sound. Specify the name of an audio file stored in the client project's app/src/main/res/raw/…"},"HarmonyRemind":{"type":"string","description":"When the push type is message and the device is offline, this push will use the supplementary popup feature. Default is false. Only…"},"HarmonyRemindTitle":{"type":"string","description":"HarmonyOS notification title used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true"},"HarmonyRemindBody":{"type":"string","description":"HarmonyOS notification content used when converting HarmonyOS messages to notifications. Only valid when HarmonyRemind is true"},"HarmonyCategory":{"type":"string","enum":["IM","VOIP","SUBSCRIPTION","TRAVEL","HEALTH","WORK","ACCOUNT","EXPRESS","FINANCE","DEVICE_REMINDER","MAIL","CUSTOMER_SERVICE","MARKETING"],"description":"Notification message category. After completing the notification message self-classification rights application, this is used to identify…"},"HarmonyNotificationSlotType":{"type":"string","enum":["SOCIAL_COMMUNICATION","SERVICE_INFORMATION","CONTENT_INFORMATION","CUSTOMER_SERVICE","OTHER_TYPES"],"description":"Use the specified notification channel type. Only effective when the Alibaba Cloud proprietary channel is online. SOCIAL_COMMUNICATION:…"},"HarmonyNotifyId":{"type":"integer","description":"Unique identifier for each message when displayed as a notification. If not provided, the push service automatically generates a unique…"},"HarmonyActionType":{"type":"string","enum":["APP_HOME_PAGE","APP_CUSTOM_PAGE"],"description":"Action after clicking the notification. Valid values: APP_HOME_PAGE: Open app home page APP_CUSTOM_PAGE: Open app custom page"},"HarmonyAction":{"type":"string","description":"The action corresponding to the in-app page ability. When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and…"},"HarmonyUri":{"type":"string","description":"The URI corresponding to the in-app page ability. When HarmonyActionType is APP_CUSTOM_PAGE, at least one of HarmonyUri and HarmonyAction…"},"HarmonyRenderStyle":{"type":"string","enum":["NORMAL","MULTI_LINE"],"description":"Notification message style: NORMAL: Standard notification (default) MULTI_LINE: Multi-line text style"},"HarmonyImageUrl":{"type":"string","description":"URL for the large icon on the right side of the notification. The URL must use the HTTPS protocol. Supported image formats: png, jpg,…"},"HarmonyInboxContent":{"type":"string","description":"Content for multi-line text style. Required when HarmonyRenderStyle is MULTI_LINE. Supports up to 3 items"},"HarmonyExtParameters":{"type":"string","description":"Set the extension attributes of the notification. This attribute does not take effect when PushType is set to MESSAGE. This parameter must…"},"HarmonyTestMessage":{"type":"string","description":"Test message flag: false: Official message (default) true: Test message For details, see the HarmonyOS official documentation…"},"HarmonyReceiptId":{"type":"string","description":"HarmonyOS channel receipt ID. This receipt ID can be found in the receipt parameter configuration on the HarmonyOS channel push management…"},"HarmonyExtensionPush":{"type":"string","description":"When PushType is NOTICE, whether to send as a HarmonyOS notification extension message. true: Send notification extension message false:…"},"HarmonyExtensionExtraData":{"type":"string","description":"Extra data for notification extension messages. Effective when sending HarmonyOS notification extension messages. Conceptually equivalent…"},"HarmonyBadgeAddNum":{"type":"integer","description":"HarmonyOS app badge increment number. Refer to HarmonyOS badge addNum field description…"},"HarmonyBadgeSetNum":{"type":"integer","description":"HarmonyOS app badge set number. Refer to HarmonyOS badge setNum field description…"},"SmsTemplateName":{"type":"string","description":"The template name for supplementary SMS. This can be obtained from the SMS template management page and is a system-assigned name, not a…"},"SmsSignName":{"type":"string","description":"The signature for supplementary SMS"},"SmsParams":{"type":"string","description":"Variable name-value pairs for the SMS template, in the format: `key1=value1&key2=value2`"},"SmsDelaySecs":{"type":"integer","description":"Delay time before triggering SMS, in seconds. Must be set when using SMS convergence. Recommended to be 15 seconds or more, with a maximum…"},"SmsSendPolicy":{"type":"integer","description":"Condition for triggering SMS. Valid values: 0: Triggered when push is not received. 1: Triggered when user has not opened the notification"},"SendSpeed":{"type":"integer","description":"This parameter is deprecated"},"AndroidXiaoMiNotifyTitle":{"type":"string","description":"This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupTitle"},"AndroidXiaoMiNotifyBody":{"type":"string","description":"This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupBody"},"AndroidXiaoMiActivity":{"type":"string","description":"This parameter is deprecated. All third-party supplementary popups are now supported by the new parameter AndroidPopupActivity"},"IdempotentToken":{"type":"string","description":"An idempotent parameter to prevent duplicate pushes caused by API client retries. When the same IdempotentToken is used for calls within…"},"AndroidMeizuNoticeMsgType":{"type":"integer","enum":["0","1"],"description":"Meizu message type: 0: Public message (default) 1: Private message"},"AndroidOppoPrivateMsgTemplateId":{"type":"string","description":"OPPO private message template ID"},"AndroidOppoPrivateTitleParameters":{"type":"string","description":"OPPO private message template title parameters (JSON-encoded)"},"AndroidOppoPrivateContentParameters":{"type":"string","description":"OPPO private message template content parameters (JSON-encoded)"},"AndroidXiaomiTemplateId":{"type":"string","description":"Xiaomi private message template ID"},"AndroidXiaomiTemplateParams":{"type":"string","description":"Xiaomi private message template parameters, JSON string"},"HarmonyLiveViewPayload":{"type":"string","description":"JSON string of the HarmonyOS Live View data structure LiveViewPayload…"},"AndroidHuaweiLiveNotificationPayload":{"type":"string","description":"JSON string of the Huawei Android Live Notification data structure LiveNotificationPayload…"},"AndroidOppoIntelligentIntent":{"type":"string","description":"JSON string of the OPPO Fluid Cloud intent sharing data structure IntelligentIntent…"},"AndroidOppoDeleteIntentData":{"type":"string","description":"JSON string of the OPPO Fluid Cloud intent deletion data structure data (https://open.oppomobile.com/documentation/page/info?id=13578).…"},"AndroidVivoLiveMessage":{"type":"string","description":"JSON string of the vivo Atomic Island data structure liveMessage (https://dev.vivo.com.cn/documentCenter/doc/896#s-fdagzbd4). For…"},"AndroidXiaomiFocusParam":{"type":"string","description":"JSON string of the Xiaomi Super Island data structure miui.focus.param (https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131).…"},"AndroidXiaomiFocusPics":{"type":"string","description":"JSON string of the Xiaomi Super Island image data miui.focus.pic_xxx (https://dev.mi.com/xiaomihyperos/documentation/detail?pId=2131). For…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push-message-to-android":{"post":{"operationId":"cloud_aliyun_push_push_message_to_android","summary":"Sends a message to an Android device through the Alibaba Cloud Mobile Push proprietary channel. After the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Target","TargetValue","Title","Body"],"properties":{"AppKey":{"type":"integer","description":"The AppKey"},"Target":{"type":"string","enum":["ALL","DEVICE","ACCOUNT","ALIAS","TAG"],"description":"The push target. Valid values: DEVICE: Pushes messages to devices. ACCOUNT: Pushes messages to accounts. ALIAS: Pushes messages to…"},"TargetValue":{"type":"string","description":"Set this parameter based on the value of \\`Target\\`. Use commas (,) to separate multiple values. If you exceed the limit, send the pushes…"},"Title":{"type":"string","description":"The title of the message"},"Body":{"type":"string","description":"The content of the message"},"StoreOffline":{"type":"string","description":"Specifies whether to store the message offline. The default value is false. If you store the message and the user is offline, the message…"},"JobKey":{"type":"string","description":"A custom ID for the push task. If \\`JobKey\\` is not empty, this field is included in the receipt logs. For more information, see…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push-message-toi-os":{"post":{"operationId":"cloud_aliyun_push_push_message_toi_os","summary":"Pushes messages to iOS devices. These messages are delivered through the proprietary channel of Alibaba…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Target","TargetValue","Title","Body"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"Target":{"type":"string","enum":["ALL","DEVICE","ACCOUNT","ALIAS","TAG"],"description":"Push target. Valid values: DEVICE: Push by device ACCOUNT: Push by account ALIAS: Push by alias TAG: Push by tag ALL: Push to all devices"},"TargetValue":{"type":"string","description":"Set based on Target. Separate multiple values with commas. If the limit is exceeded, push multiple times. Target=DEVICE. Example values:…"},"Title":{"type":"string","description":"The title of the message"},"Body":{"type":"string","description":"The content of the message"},"StoreOffline":{"type":"string","description":"Whether to store the message offline. StoreOffline is set to false by default. If stored, and the user is offline during the push, the…"},"JobKey":{"type":"string","description":"The custom ID for the push Job. If JobKey is not empty, this field is included in the receipt log. For receipt logs, see…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push-notice-to-android":{"post":{"operationId":"cloud_aliyun_push_push_notice_to_android","summary":"Sends a notification to Android devices. The notification appears directly in the device’s notification tray…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Target","TargetValue","Title","Body"],"properties":{"AppKey":{"type":"integer","description":"Your AppKey"},"Target":{"type":"string","enum":["ALL","DEVICE","ACCOUNT","ALIAS","TAG"],"description":"The target of the push. Valid values: DEVICE: Push to specific devices. ACCOUNT: Push to specific accounts. ALIAS: Push to users with…"},"TargetValue":{"type":"string","description":"Set this based on the Target value. Separate multiple values with commas. If you exceed the limit, send multiple requests. If…"},"Title":{"type":"string","description":"The title of the notification"},"Body":{"type":"string","description":"The body of the notification"},"StoreOffline":{"type":"string","description":"Whether to store the notification for offline delivery. Default: false. If enabled, the notification is redelivered when the user comes…"},"JobKey":{"type":"string","description":"A custom ID for the push task. If you specify a non-empty JobKey, it appears in the delivery receipt log. For more information, see…"},"ExtParameters":{"type":"string","description":"Custom key-value pairs for Android-specific extensions. Pass this as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push-notice-toi-os":{"post":{"operationId":"cloud_aliyun_push_push_notice_toi_os","summary":"Send a notification to iOS devices. The notification uses Apple’s APNs channel and appears directly in the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Target","TargetValue","ApnsEnv","Body"],"properties":{"AppKey":{"type":"integer","description":"Your AppKey"},"Target":{"type":"string","enum":["ALL","DEVICE","ACCOUNT","ALIAS","TAG"],"description":"The target of the push. Valid values: DEVICE: Push to specific devices. ACCOUNT: Push to specific accounts. ALIAS: Push to users with…"},"TargetValue":{"type":"string","description":"Values depend on the Target value. Separate multiple values with commas. If you exceed the limit, send multiple requests. If…"},"ApnsEnv":{"type":"string","enum":["DEV","PRODUCT"],"description":"iOS notifications use Apple’s APNs service. Specify the environment. DEV: Development environment. PRODUCT: Production environment"},"Title":{"type":"string","description":"The title of the notification. iOS 10 and later: Displays as the notification title. iOS 8.2 through iOS 9.x: Replaces the app name in the…"},"Body":{"type":"string","description":"The body text of the notification"},"JobKey":{"type":"string","description":"A custom ID for the push task. If you specify a JobKey, the delivery log includes this field. For more information, see…"},"ExtParameters":{"type":"string","description":"A custom key-value map for developer extensions. For iOS devices, pass this parameter as a JSON object. Otherwise, parsing fails"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/push-v2":{"post":{"operationId":"cloud_aliyun_push_push_v2","summary":"Sends a push notification by using the advanced push API V2","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","PushTask"],"properties":{"AppKey":{"type":"integer","description":"The AppKey information"},"IdempotentToken":{"type":"string","description":"An idempotence parameter that prevents duplicate push notifications caused by retries from the API caller. If you use the same…"},"PushTask":{"type":"string","description":"The push task (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-aliases":{"post":{"operationId":"cloud_aliyun_push_query_aliases","summary":"Query the list of aliases attached to a specified device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"DeviceId":{"type":"string","description":"The unique identifier for the device in Mobile Push. It is 32 characters long and contains only digits and lowercase letters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-device-info":{"post":{"operationId":"cloud_aliyun_push_query_device_info","summary":"Query details of a specified device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"DeviceId":{"type":"string","description":"The unique identity of the device in the push system. Query only one at a time"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-device-stat":{"post":{"operationId":"cloud_aliyun_push_query_device_stat","summary":"Queries device statistics by application dimension","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","StartTime","EndTime","QueryType"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"StartTime":{"type":"string","description":"The start time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ. The…"},"EndTime":{"type":"string","description":"The end time of the query. The time format follows the ISO8601 standard and uses UTC time, in the format YYYY-MM-DDThh:mm:ssZ. The…"},"DeviceType":{"type":"string","enum":["iOS","ANDROID","ALL"],"description":"This parameter is only valid for early Android and iOS dual-platform application types. If your application is a dual-platform…"},"QueryType":{"type":"string","enum":["NEW","TOTAL"],"description":"Query new devices or historical cumulative devices. Valid values: NEW: New devices TOTAL: Cumulative devices"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-devices-by-account":{"post":{"operationId":"cloud_aliyun_push_query_devices_by_account","summary":"Retrieve the list of devices associated with an account using the account name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Account"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"Account":{"type":"string","description":"Account name. You can query only one account at a time"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-devices-by-alias":{"post":{"operationId":"cloud_aliyun_push_query_devices_by_alias","summary":"Query the list of devices by alias","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","Alias"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"Alias":{"type":"string","description":"The alias. You can query only one alias at a time"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-push-records":{"post":{"operationId":"cloud_aliyun_push_query_push_records","summary":"You can query push records with pagination and basic filtering","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","StartTime","EndTime"],"properties":{"AppKey":{"type":"integer","description":"The AppKey of the application"},"StartTime":{"type":"string","description":"The start time for the query. Specify the time in UTC, using the ISO-8601 format `YYYY-MM-DDThh:mm:ssZ`"},"EndTime":{"type":"string","description":"The end time for the query. Specify the time in UTC, using the ISO-8601 format `YYYY-MM-DDThh:mm:ssZ`"},"PushType":{"type":"string","enum":["MESSAGE","NOTICE","LIVE_ACTIVITY"],"description":"The push type. Valid values: MESSAGE: A message. NOTICE: A notification. LIVE_ACTIVITY: A Live Activity"},"Target":{"type":"string","enum":["ACCOUNT","ALIAS","DEVICE","TAG","TBD","FILE","ALL"],"description":"The push target. Valid values: DEVICE: Push to devices. ACCOUNT: Push to accounts. ALIAS: Push to aliases. TAG: Push to tags. ALL: Push to…"},"Source":{"type":"string","enum":["CONSOLE","API","OpenAPIExplorer"],"description":"The push source. Valid values: API: Pushes initiated via an OpenAPI call. CONSOLE: Pushes initiated from the Mobile Push console.…"},"Keyword":{"type":"string","description":"The keyword used for the query. The search covers the `MessageId`, `Title`, and `Body` fields. For `Title` and `Body`, the system applies…"},"NextToken":{"type":"string","description":"This parameter is deprecated"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default: 20. Maximum: 100"},"Page":{"type":"integer","description":"The page number to query. Default: 1. Maximum: 10,000"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-push-stat-by-app":{"post":{"operationId":"cloud_aliyun_push_query_push_stat_by_app","summary":"Query push statistics for an app","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","StartTime","EndTime","Granularity"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"StartTime":{"type":"string","description":"The start time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ"},"EndTime":{"type":"string","description":"The end time of the query. Specify the time in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ"},"Granularity":{"type":"string","enum":["DAY"],"description":"The data granularity of the response. You can only query data for up to 31 days at daily granularity. Valid values: DAY: Query data at…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-push-stat-by-msg":{"post":{"operationId":"cloud_aliyun_push_query_push_stat_by_msg","summary":"Queries push statistics for a message","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","MessageId"],"properties":{"AppKey":{"type":"integer","description":"The AppKey"},"MessageId":{"type":"integer","description":"The ID of the pushed message. This ID is returned after a message is pushed. Push data is available the next day. You cannot query data…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-tags":{"post":{"operationId":"cloud_aliyun_push_query_tags","summary":"Queries tags for a specified object, such as a device, account, or alias","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","ClientKey","KeyType"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"ClientKey":{"type":"string","description":"The device, account, or alias. Query one ClientKey at a time"},"KeyType":{"type":"string","enum":["DEVICE","ACCOUNT","ALIAS"],"description":"The type of the ClientKey"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/query-unique-device-stat":{"post":{"operationId":"cloud_aliyun_push_query_unique_device_stat","summary":"Obtain deduplicated device statistics for an app","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","StartTime","EndTime","Granularity"],"properties":{"AppKey":{"type":"integer","description":"Your app key"},"StartTime":{"type":"string","description":"The start time of the query, in ISO 8601 format. Format: YYYY-MM-DDThh:mm:ssZ"},"EndTime":{"type":"string","description":"The end time of the query, in ISO 8601 format. Format: YYYY-MM-DDThh:mm:ssZ"},"Granularity":{"type":"string","enum":["DAY","MONTH"],"description":"The time granularity for the query. Valid values: DAY MONTH"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/remove-tag":{"post":{"operationId":"cloud_aliyun_push_remove_tag","summary":"Removes a tag from an app","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","TagName"],"properties":{"AppKey":{"type":"integer","description":"The AppKey value"},"TagName":{"type":"string","description":"The name of the tag to remove. You can remove only one tag at a time. Maximum length: 128 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/unbind-alias":{"post":{"operationId":"cloud_aliyun_push_unbind_alias","summary":"Unbinds an alias. The change takes effect immediately","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId"],"properties":{"AppKey":{"type":"integer","description":"The AppKey"},"DeviceId":{"type":"string","description":"The unique device identifier for push notifications. It is 32 characters long and consists of digits and lowercase letters"},"AliasName":{"type":"string","description":"The alias to detach. An alias supports up to 128 bytes (one Chinese character counts as 3 bytes). This field is required when UnbindAll is…"},"UnbindAll":{"type":"string","description":"Whether to detach all aliases. Default is false. If true, detaches all aliases currently bound to the device. If false, detaches only the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/unbind-phone":{"post":{"operationId":"cloud_aliyun_push_unbind_phone","summary":"Unbind the mobile phone number from a specified device","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","DeviceId"],"properties":{"AppKey":{"type":"integer","description":"AppKey information"},"DeviceId":{"type":"string","description":"The unique identity of the device. It is 32 characters long and consists of digits and lowercase letters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/unbind-tag":{"post":{"operationId":"cloud_aliyun_push_unbind_tag","summary":"Unbinds one or more tags from a specified target","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppKey","ClientKey","KeyType","TagName"],"properties":{"AppKey":{"type":"integer","description":"The AppKey of your application"},"ClientKey":{"type":"string","description":"The ID of the device"},"KeyType":{"type":"string","enum":["DEVICE","ACCOUNT","ALIAS"],"description":"The type of the ClientKey. Valid value: DEVICE: The key is a device ID"},"TagName":{"type":"string","description":"Specifies the tag to unbind. To unbind multiple tags, separate them with commas. A maximum of 10 tags, each up to 128 characters long, can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-push/version":{"post":{"operationId":"cloud_aliyun_push_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}