'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Push',
'version' => '2016-08-01',
],
'directories' => [
[
'id' => 165111,
'title' => null,
'type' => 'directory',
'children' => [
'Push',
'MassPush',
'ContinuouslyPush',
'CompleteContinuouslyPush',
'CancelPush',
'PushV2',
'MassPushV2',
],
],
[
'id' => 165112,
'title' => null,
'type' => 'directory',
'children' => [
'CheckCertificate',
'QueryPushRecords',
'QueryDeviceStat',
'QueryUniqueDeviceStat',
'QueryDeviceInfo',
'QueryPushStatByApp',
'QueryPushStatByMsg',
'CheckDevices',
],
],
[
'id' => 95678,
'title' => null,
'type' => 'directory',
'children' => [
'BindTag',
'UnbindTag',
'RemoveTag',
'QueryTags',
'ListTags',
],
],
[
'id' => 165138,
'title' => null,
'type' => 'directory',
'children' => [
'BindAlias',
'UnbindAlias',
'QueryAliases',
'QueryDevicesByAlias',
],
],
[
'id' => 95697,
'title' => null,
'type' => 'directory',
'children' => [
'QueryDevicesByAccount',
],
],
[
'id' => 95671,
'title' => null,
'type' => 'directory',
'children' => [
'BindPhone',
'UnbindPhone',
],
],
[
'id' => 200051,
'title' => null,
'type' => 'directory',
'children' => [
'PushMessageToiOS',
'PushNoticeToiOS',
'PushNoticeToAndroid',
'PushMessageToAndroid',
'CheckDevice',
'ListSummaryApps',
],
],
],
'components' => [
'schemas' => [
'PushTask' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Action' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'SCHEDULED_PUSH' => '',
'CREATE_CONTINUOUS_PUSH' => '',
'PUSH_IMMEDIATELY' => '',
'CONTINUOUS_PUSH' => '',
],
'example' => 'PUSH_IMMEDIATELY',
'backendName' => 'action',
'enum' => [
'PUSH_IMMEDIATELY',
'SCHEDULED_PUSH',
'CREATE_CONTINUOUS_PUSH',
'CONTINUOUS_PUSH',
],
],
'Target' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ALL' => '',
'ACCOUNT' => '',
'ALIAS' => '',
'DEVICE' => '',
'TAG' => '',
],
'example' => 'DEVICE',
'backendName' => 'type',
'enum' => [
'DEVICE',
'TAG',
'ALIAS',
'ACCOUNT',
'ALL',
'FILE',
],
],
'Platform' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'ALL' => '',
'HMOS' => '',
'ANDROID' => '',
'IOS' => '',
],
'example' => 'IOS',
'backendName' => 'platform',
'enum' => [
'ANDROID',
'IOS',
'HMOS',
'ALL',
],
],
'Value' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'value',
'backendName' => 'value',
],
],
'backendName' => 'target',
],
'Message' => [
'title' => '',
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Title' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'title',
'backendName' => 'title',
],
'Body' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => false,
'example' => '{"key": "value"}',
'backendName' => 'body',
],
],
'backendName' => 'message',
],
'Notification' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Title' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [],
'example' => '',
'backendName' => 'title',
],
'Hmos' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'InboxContent' => [
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'extendType' => 'true',
],
'backendName' => 'inboxContent',
],
'Action' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'com.example.action',
'backendName' => 'action',
],
'Category' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [
'TRAVEL' => '',
'IM' => '',
'VOIP' => '',
'SUBSCRIPTION' => '',
'MARKETING' => '',
'CUSTOMER_SERVICE' => '',
'ACCOUNT' => '',
'MAIL' => '',
'FINANCE' => '',
'EXPRESS' => '',
'WORK' => '',
'HEALTH' => '',
'DEVICE_REMINDER' => '',
],
'example' => 'IM',
'backendName' => 'category',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
'RenderStyle' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [
'NORMAL' => '',
'MULTI_LINE' => '',
],
'example' => 'NORMAL',
'backendName' => 'renderStyle',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
'BadgeAddNum' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'badgeAddNum',
],
'ImageUrl' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'https://example.com/xxx.png',
'backendName' => 'imageUrl',
],
'ExtParameters' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '{"key": "value"}',
'backendName' => 'extParameters',
],
'Uri' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'https://www.example.com:8080/push/example',
'backendName' => 'uri',
],
'SlotType' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [
'CONTENT_INFORMATION' => '',
'UNKNOWN_TYPE' => '',
'LIVE_VIEW' => '',
'SOCIAL_COMMUNICATION' => '',
'CUSTOMER_SERVICE' => '',
'OTHER_TYPES' => '',
'SERVICE_INFORMATION' => '',
],
'example' => 'SOCIAL_COMMUNICATION',
'backendName' => 'slotType',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
'UNKNOWN_TYPE',
'LIVE_VIEW',
],
],
'ExtensionExtraData' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'text',
'backendName' => 'extensionExtraData',
],
'ReceiptId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'RCPB***DFD5',
'backendName' => 'receiptId',
],
'ExtensionPush' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'extensionPush',
],
'TestMessage' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'testMessage',
],
'BadgeSetNum' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'badgeSetNum',
],
'NotifyId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '123456',
'backendName' => 'notifyId',
],
],
'backendName' => 'hmos',
],
'Ios' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'CollapseId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'order_status_update_12345',
'backendName' => 'collapseId',
],
'Category' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'MESSAGE_REPLY',
'backendName' => 'category',
],
'Silent' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'silent',
],
'ExtParameters' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '{"attachment": "https://xxxx.xxx/notification_pic.png"} ',
'backendName' => 'extParameters',
],
'Badge' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'badge',
],
'RelevanceScore' => [
'description' => '',
'visibility' => 'Public',
'type' => 'number',
'format' => 'double',
'example' => '0.5',
'backendName' => 'relevanceScore',
],
'ApnsEnv' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [
'DEV' => '',
'PRODUCT' => '',
],
'example' => 'DEV',
'backendName' => 'apnsEnv',
'enum' => [
'DEV',
'PRODUCT',
],
],
'Subtitle' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'subtitle',
],
'Mutable' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'true',
'backendName' => 'mutable',
],
'LiveActivity' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'AttributesType' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'OrderActivityAttributes',
'backendName' => 'attributesType',
],
'Attributes' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'attributes',
],
'StaleDate' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1701425400',
'backendName' => 'staleDate',
],
'Event' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'required' => false,
'example' => 'start',
'backendName' => 'event',
'enum' => [
'start',
'update',
'end',
],
],
'DismissalDate' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1701439800',
'backendName' => 'dismissalDate',
],
'Id' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'FOOD_DELIVERY_ORD20231201001',
'backendName' => 'id',
],
'ContentState' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'contentState',
],
],
'backendName' => 'liveActivity',
],
'InterruptionLevel' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'active',
'backendName' => 'interruptionLevel',
'enum' => [
'passive',
'active',
'time-sensitive',
'critical',
],
],
'ThreadId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'news_category_tech',
'backendName' => 'threadId',
],
'Music' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'default',
'backendName' => 'music',
],
'BadgeAutoIncrement' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'badgeAutoIncrement',
],
],
'backendName' => 'ios',
],
'Body' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'body',
],
'Android' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'InboxContent' => [
'description' => '',
'visibility' => 'Public',
'type' => 'array',
'items' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'extendType' => 'true',
],
'backendName' => 'inboxContent',
],
'Options' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Honor' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Importance' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'backendName' => 'importance',
'enum' => [
'0',
'1',
],
],
],
'backendName' => 'honor',
],
'Xiaomi' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Channel' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'michannel',
'backendName' => 'channel',
],
],
'backendName' => 'xiaomi',
],
'Vivo' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Importance' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'backendName' => 'importance',
'enum' => [
'0',
'1',
],
],
'Category' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'MARKETING',
'backendName' => 'category',
'enum' => [
'IM',
'ACCOUNT',
'DEVICE_REMINDER',
'ORDER',
'TODO',
'SUBSCRIPTION',
'NEWS',
'CONTENT',
'MARKETING',
'SOCIAL',
],
],
'ReceiptId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '1232221',
'backendName' => 'receiptId',
],
],
'backendName' => 'vivo',
],
'Oppo' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Category' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'NEWS',
'backendName' => 'category',
'enum' => [
'IM',
'ACCOUNT',
'DEVICE_REMINDER',
'ORDER',
'TODO',
'SUBSCRIPTION',
'NEWS',
'CONTENT',
'MARKETING',
'SOCIAL',
],
],
'NotifyLevel' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
'backendName' => 'notifyLevel',
'enum' => [
'1',
'2',
'16',
],
],
],
'backendName' => 'oppo',
],
'Huawei' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Importance' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'backendName' => 'importance',
'enum' => [
'0',
'1',
],
],
'ReceiptId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'RCP4C123456',
'backendName' => 'receiptId',
],
'Category' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'VOIP',
'backendName' => 'category',
],
'Urgency' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'NORMAL',
'backendName' => 'urgency',
'enum' => [
'HIGH',
'NORMAL',
],
],
],
'backendName' => 'huawei',
],
'Accs' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NotifyType' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'NONE',
'backendName' => 'notifyType',
'enum' => [
'VIBRATE',
'SOUND',
'BOTH',
'NONE',
],
],
'OpenType' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'APPLICATION',
'backendName' => 'openType',
'enum' => [
'APPLICATION',
'ACTIVITY',
'URL',
'NONE',
],
],
'ThreadId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'order_ORD20231201001',
'backendName' => 'threadId',
],
'Priority' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'backendName' => 'priority',
],
'OpenUrl' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'www.example.com',
'backendName' => 'openUrl',
],
'CustomStyle' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'customStyle',
],
'OpenActivity' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
'backendName' => 'openActivity',
],
],
'backendName' => 'accs',
],
],
'backendName' => 'options',
],
'VendorChannelActivity' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
'backendName' => 'vendorChannelActivity',
],
'RenderStyle' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '0',
'backendName' => 'renderStyle',
'enum' => [
'NORMAL',
'BIG_TEXT',
'BIG_PICTURE',
'MULTI_LINE',
],
],
'BadgeAddNum' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
'backendName' => 'badgeAddNum',
],
'ImageUrl' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'https://imag.example.com/image.png',
'backendName' => 'imageUrl',
],
'ExtParameters' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '{"key1":"value1"}',
'backendName' => 'extParameters',
],
'ChannelId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '8.0up',
'backendName' => 'channelId',
],
'BadgeActivity' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
'backendName' => 'badgeActivity',
],
'GroupId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'group-1',
'backendName' => 'groupId',
],
'Music' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'alicloud_notification_sound',
'backendName' => 'music',
],
'PictureUrl' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'https://imag.example.com/image.png',
'backendName' => 'pictureUrl',
],
'TestMessage' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'testMessage',
],
'BadgeSetNum' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
'backendName' => 'badgeSetNum',
],
'NotifyId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int32',
'example' => '233856727',
'backendName' => 'notifyId',
],
],
'backendName' => 'android',
],
],
'backendName' => 'notification',
],
'Options' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'PushTime' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2025-06-19T12:00:00Z',
'backendName' => 'pushTime',
],
'JobKey' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'jobkey1727749697913',
'backendName' => 'jobKey',
],
'Trim' => [
'description' => '',
'visibility' => 'Public',
'type' => 'boolean',
'example' => 'false',
'backendName' => 'trim',
],
'Sms' => [
'description' => '',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'SendPolicy' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => [
'PUSH_NOT_RECEIVED' => '',
'USER_NOT_OPENED' => '',
],
'example' => 'PUSH_NOT_RECEIVED',
'backendName' => 'sendPolicy',
'enum' => [
'PUSH_NOT_RECEIVED',
'USER_NOT_OPENED',
],
],
'TemplateName' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'SMS_123456789',
'backendName' => 'templateName',
],
'Params' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'key1=value1&key2=value2',
'backendName' => 'params',
],
'SignName' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '',
'backendName' => 'signName',
],
'DelaySecs' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '150',
'backendName' => 'delaySecs',
],
],
'backendName' => 'sms',
],
'UseChannels' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => 'accs,apns',
'backendName' => 'useChannels',
],
'ExpireTime' => [
'description' => '',
'visibility' => 'Public',
'type' => 'string',
'example' => '2025-06-21T12:00:00Z',
'backendName' => 'expireTime',
],
'MessageId' => [
'description' => '',
'visibility' => 'Public',
'type' => 'integer',
'format' => 'int64',
'example' => '1174754033128****',
'backendName' => 'messageId',
],
],
'backendName' => 'options',
],
],
],
],
],
'apis' => [
'Push' => [
'summary' => '高级推送接口',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREemasBNY9P0',
'FEATUREemasTZ8VEZ',
],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267207',
],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'MESSAGE',
'enum' => [
'MESSAGE',
'NOTICE',
],
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL',
'enum' => [
'iOS',
'ANDROID',
'ALL',
],
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
'TBD',
'FILE',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'SendChannels',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'accs,huawei,xiaomi',
],
],
[
'name' => 'PushTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
],
[
'name' => 'ExpireTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'hello',
],
],
[
'name' => 'Trim',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'iOSApnsEnv',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DEV',
'enum' => [
'PRODUCT',
'DEV',
],
],
],
[
'name' => 'iOSRemind',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSSubtitle',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'su\'b',
],
],
[
'name' => 'iOSRemindBody',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'iOSMusic',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '""',
],
],
[
'name' => 'iOSBadge',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'iOSBadgeAutoIncrement',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSSilentNotification',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSMutableContent',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'iOSNotificationCategory',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ios',
],
],
[
'name' => 'iOSNotificationCollapseId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ZD2011',
],
],
[
'name' => 'iOSNotificationThreadId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
],
[
'name' => 'iOSInterruptionLevel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'active',
],
],
[
'name' => 'iOSRelevanceScore',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'required' => false,
'example' => '0.01',
],
],
[
'name' => 'iOSExtParameters',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{“attachment”: “https://xxxx.xxx/notification_pic.png"} ',
],
],
[
'name' => 'iOSLiveActivityEvent',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => [
'start',
'update',
'end',
],
],
],
[
'name' => 'iOSLiveActivityId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'iOSLiveActivityAttributesType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'iOSLiveActivityAttributes',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'iOSLiveActivityContentState',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'iOSLiveActivityDismissalDate',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
[
'name' => 'iOSLiveActivityStaleDate',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
],
],
[
'name' => 'AndroidNotifyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'BOTH',
'enum' => [
'NONE',
'VIBRATE',
'SOUND',
'BOTH',
],
],
],
[
'name' => 'AndroidRemind',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AndroidOpenType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'APPLICATION',
'enum' => [
'APPLICATION',
'ACTIVITY',
'URL',
'NONE',
],
],
],
[
'name' => 'AndroidActivity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
],
[
'name' => 'AndroidOpenUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://xxxx.xxx',
],
],
[
'name' => 'AndroidPopupActivity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
],
[
'name' => 'AndroidPopupTitle',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'AndroidPopupBody',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
],
[
'name' => 'AndroidRenderStyle',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AndroidBigTitle',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'AndroidBigBody',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'AndroidBigPictureUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
],
[
'name' => 'AndroidXiaomiBigPictureUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png',
'deprecated' => true,
],
],
[
'name' => 'AndroidImageUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
],
[
'name' => 'AndroidXiaomiImageUrl',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
'deprecated' => true,
],
],
[
'name' => 'AndroidInboxBody',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'AndroidNotificationBarType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '0',
'example' => '2',
],
],
[
'name' => 'AndroidNotificationBarPriority',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '2',
'minimum' => '-2',
'example' => '0',
],
],
[
'name' => 'AndroidNotificationNotifyId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100001',
],
],
[
'name' => 'AndroidNotificationChannel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AndroidNotificationHuaweiChannel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
],
[
'name' => 'AndroidNotificationHonorChannel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
],
[
'name' => 'AndroidNotificationXiaomiChannel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'michannel',
],
],
[
'name' => 'AndroidNotificationVivoChannel',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'classification',
],
],
[
'name' => 'AndroidNotificationGroup',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'group-1',
],
],
[
'name' => 'AndroidNotificationThreadId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidExtParameters',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
],
[
'name' => 'AndroidMessageHuaweiUrgency',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HIGH',
],
],
[
'name' => 'AndroidMessageHuaweiCategory',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'VOIP',
],
],
[
'name' => 'AndroidMessageOppoCategory',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidMessageOppoNotifyLevel',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'AndroidMessageVivoCategory',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TODO',
],
],
[
'name' => 'AndroidTargetUserType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiTargetUserType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHonorTargetUserType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidVivoPushMode',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidOppoIntentEnv',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiBusinessType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidHuaweiReceiptId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'RCP4C123456',
],
],
[
'name' => 'AndroidVivoReceiptId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidBadgeClass',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidBadgeAddNum',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'maximum' => '99',
'minimum' => '1',
],
],
[
'name' => 'AndroidBadgeSetNum',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'maximum' => '99',
'minimum' => '1',
],
],
[
'name' => 'AndroidMusic',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'HarmonyRemind',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'HarmonyRemindTitle',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyRemindBody',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyCategory',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
],
[
'name' => 'HarmonyNotificationSlotType',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
],
],
],
[
'name' => 'HarmonyNotifyId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'HarmonyActionType',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => [
'APP_HOME_PAGE',
'APP_CUSTOM_PAGE',
],
],
],
[
'name' => 'HarmonyAction',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyUri',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyRenderStyle',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
],
[
'name' => 'HarmonyImageUrl',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyInboxContent',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyExtParameters',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyTestMessage',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'HarmonyReceiptId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyExtensionPush',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'HarmonyExtensionExtraData',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'HarmonyBadgeAddNum',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'HarmonyBadgeSetNum',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
],
],
[
'name' => 'SmsTemplateName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'SmsSignName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'SmsParams',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'key1=value1',
],
],
[
'name' => 'SmsDelaySecs',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '15',
],
],
[
'name' => 'SmsSendPolicy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '1',
'minimum' => '0',
'example' => '0',
],
],
[
'name' => 'SendSpeed',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'deprecated' => true,
'required' => false,
'minimum' => '10000',
'example' => '0',
],
],
[
'name' => 'AndroidXiaoMiNotifyTitle',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
],
[
'name' => 'AndroidXiaoMiNotifyBody',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
],
[
'name' => 'AndroidXiaoMiActivity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'type' => 'string',
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'AndroidMeizuNoticeMsgType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'type' => 'integer',
'format' => 'int32',
'docRequired' => false,
'example' => '0',
'enum' => [
'0',
'1',
],
],
],
[
'name' => 'AndroidOppoPrivateMsgTemplateId',
'in' => 'query',
'schema' => [
'title' => '私信模板ID',
'type' => 'string',
],
],
[
'name' => 'AndroidOppoPrivateTitleParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '私信标题参数',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
],
],
],
[
'name' => 'AndroidOppoPrivateContentParameters',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '私信内容参数',
'type' => 'object',
'additionalProperties' => [
'type' => 'string',
],
],
],
[
'name' => 'HarmonyLiveViewPayload',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidHuaweiLiveNotificationPayload',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidOppoIntelligentIntent',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'AndroidOppoDeleteIntentData',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'responseParamsDescription' => ' ',
],
'MassPush' => [
'summary' => '批量推送',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREemasBNY9P0',
'FEATUREemasTZ8VEZ',
],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '23267207',
],
],
[
'name' => 'PushTask',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'PushType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'MESSAGE',
],
'DeviceType' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
],
'Target' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
],
'TargetValue' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'deviceid1,deviceid2',
],
'StoreOffline' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'SendChannels' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'accs,huawei,xiaomi',
],
'PushTime' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
'ExpireTime' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '2019-02-20T00:00:00Z',
],
'JobKey' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
'Title' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'title',
],
'Body' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'Trim' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'iOSApnsEnv' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DEV',
],
'iOSRemind' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSSubtitle' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'subtitle',
],
'iOSRemindBody' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'iOSMusic' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '””',
],
'iOSBadge' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'iOSBadgeAutoIncrement' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSSilentNotification' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSMutableContent' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'iOSNotificationCategory' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ios',
],
'iOSNotificationCollapseId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ZD2011',
],
'iOSNotificationThreadId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
'iOSInterruptionLevel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'active',
],
'iOSRelevanceScore' => [
'description' => '',
'type' => 'number',
'format' => 'double',
'required' => false,
'example' => '0.01',
],
'iOSExtParameters' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{“attachment”: “https://xxxx.xxx/notification_pic.png"} ',
],
'iOSLiveActivityEvent' => [
'type' => 'string',
'enum' => [
'start',
'update',
'end',
],
],
'iOSLiveActivityId' => [
'type' => 'string',
],
'iOSLiveActivityAttributesType' => [
'type' => 'string',
],
'iOSLiveActivityAttributes' => [
'type' => 'string',
],
'iOSLiveActivityContentState' => [
'type' => 'string',
],
'iOSLiveActivityDismissalDate' => [
'type' => 'integer',
'format' => 'int64',
],
'iOSLiveActivityStaleDate' => [
'type' => 'integer',
'format' => 'int64',
],
'AndroidNotifyType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'VIBRATE',
],
'AndroidRemind' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'AndroidOpenType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'APPLICATION',
],
'AndroidActivity' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'AndroidOpenUrl' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://xxxx.xxx',
],
'AndroidPopupActivity' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'com.alibaba.cloudpushdemo.bizactivity',
],
'AndroidPopupTitle' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'AndroidPopupBody' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'hello',
],
'AndroidRenderStyle' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'AndroidBigTitle' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'AndroidBigBody' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'AndroidBigPictureUrl' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
'AndroidXiaomiBigPictureUrl' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://f6.market.xiaomi.com/download/MiPass/aaa/bbb.png',
'deprecated' => true,
],
'AndroidImageUrl' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
],
'AndroidXiaomiImageUrl' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'https://imag.example.com/image.png',
'deprecated' => true,
],
'AndroidInboxBody' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'AndroidNotificationBarType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
'AndroidNotificationBarPriority' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
'AndroidNotificationNotifyId' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100001',
],
'AndroidNotificationChannel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'AndroidNotificationHuaweiChannel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
'AndroidNotificationHonorChannel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'LOW',
],
'AndroidNotificationXiaomiChannel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'michannel',
],
'AndroidNotificationVivoChannel' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '0',
],
'AndroidNotificationGroup' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'group-1',
],
'AndroidNotificationThreadId' => [
'type' => 'string',
],
'AndroidExtParameters' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
'AndroidMessageHuaweiUrgency' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'HIGH',
],
'AndroidMessageHuaweiCategory' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'VOIP',
],
'AndroidMessageOppoCategory' => [
'type' => 'string',
],
'AndroidMessageOppoNotifyLevel' => [
'type' => 'integer',
'format' => 'int32',
],
'AndroidMessageVivoCategory' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TODO',
],
'AndroidTargetUserType' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiTargetUserType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidHonorTargetUserType' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
'AndroidVivoPushMode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'enum' => [
'0',
'1',
],
],
'AndroidOppoIntentEnv' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiBusinessType' => [
'type' => 'integer',
'format' => 'int32',
'enum' => [
'0',
'1',
],
],
'AndroidHuaweiReceiptId' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'RCP4C123456',
],
'AndroidVivoReceiptId' => [
'type' => 'string',
],
'AndroidBadgeClass' => [
'type' => 'string',
],
'AndroidBadgeAddNum' => [
'type' => 'integer',
'format' => 'int32',
'example' => '99',
'default' => '1',
],
'AndroidBadgeSetNum' => [
'type' => 'integer',
'format' => 'int32',
'example' => '99',
'default' => '0',
],
'AndroidMusic' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'HarmonyRemind' => [
'type' => 'boolean',
],
'HarmonyRemindTitle' => [
'type' => 'string',
],
'HarmonyRemindBody' => [
'type' => 'string',
],
'HarmonyCategory' => [
'type' => 'string',
'enum' => [
'IM',
'VOIP',
'SUBSCRIPTION',
'TRAVEL',
'HEALTH',
'WORK',
'ACCOUNT',
'EXPRESS',
'FINANCE',
'DEVICE_REMINDER',
'MAIL',
'CUSTOMER_SERVICE',
'MARKETING',
],
],
'HarmonyNotificationSlotType' => [
'type' => 'string',
'enum' => [
'SOCIAL_COMMUNICATION',
'SERVICE_INFORMATION',
'CONTENT_INFORMATION',
'CUSTOMER_SERVICE',
'OTHER_TYPES',
],
],
'HarmonyNotifyId' => [
'type' => 'integer',
'format' => 'int32',
],
'HarmonyActionType' => [
'type' => 'string',
'enum' => [
'APP_HOME_PAGE',
'APP_CUSTOM_PAGE',
],
],
'HarmonyAction' => [
'type' => 'string',
],
'HarmonyUri' => [
'type' => 'string',
],
'HarmonyRenderStyle' => [
'type' => 'string',
'enum' => [
'NORMAL',
'MULTI_LINE',
],
],
'HarmonyImageUrl' => [
'type' => 'string',
],
'HarmonyInboxContent' => [
'type' => 'string',
],
'HarmonyExtParameters' => [
'type' => 'string',
],
'HarmonyTestMessage' => [
'type' => 'boolean',
],
'HarmonyReceiptId' => [
'type' => 'string',
],
'HarmonyExtensionPush' => [
'type' => 'boolean',
],
'HarmonyExtensionExtraData' => [
'type' => 'string',
],
'HarmonyBadgeAddNum' => [
'type' => 'integer',
'format' => 'int32',
],
'HarmonyBadgeSetNum' => [
'type' => 'integer',
'format' => 'int32',
],
'SendSpeed' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'deprecated' => true,
'required' => false,
'example' => '0',
],
'AndroidXiaoMiNotifyTitle' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
'AndroidXiaoMiNotifyBody' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
'AndroidXiaoMiActivity' => [
'description' => '',
'type' => 'string',
'deprecated' => true,
'required' => false,
'example' => '',
],
'AndroidMeizuNoticeMsgType' => [
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => [
'0',
'1',
],
],
'AndroidOppoPrivateMsgTemplateId' => [
'title' => 'Oppo私信模板ID,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'type' => 'string',
'deprecated' => true,
],
'AndroidOppoPrivateTitleParameters' => [
'title' => 'Oppo私信模板title参数,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'type' => 'object',
'deprecated' => true,
'additionalProperties' => [
'type' => 'string',
],
],
'AndroidOppoPrivateContentParameters' => [
'title' => 'Oppo私信模板content参数,已废弃,如需使用请使用Push接口,或升级MassPushV2',
'type' => 'object',
'deprecated' => true,
'additionalProperties' => [
'type' => 'string',
],
],
'HarmonyLiveViewPayload' => [
'type' => 'string',
'required' => false,
],
'AndroidHuaweiLiveNotificationPayload' => [
'type' => 'string',
'required' => false,
],
'AndroidOppoIntelligentIntent' => [
'type' => 'string',
'required' => false,
],
'AndroidOppoDeleteIntentData' => [
'type' => 'string',
'required' => false,
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'type' => 'string',
'maxLength' => 36,
'minLength' => 36,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MessageId' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '501030',
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageIds\\": {\\n \\"MessageId\\": [\\n \\"501030\\"\\n ]\\n },\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'ContinuouslyPush' => [
'summary' => '持续推送',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '23267207',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '500131',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'DEVICE',
'required' => true,
'type' => 'string',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'a692961a92534047ad3625****',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'MessageId' => [
'description' => '',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
'type' => 'string',
],
'RequestId' => [
'description' => '',
'example' => '500131',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC \\n 500131\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'CompleteContinuouslyPush' => [
'summary' => '完成持续推送任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '4010290149170430',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '4010290149170430',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"500131\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC \\n 500131\\n","errorExample":""}]',
],
'CancelPush' => [
'summary' => '取消定时推送任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '501029',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n","errorExample":""}]',
],
'PushV2' => [
'summary' => '新版高级推送接口',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREemasBNY9P0',
'FEATUREemasTZ8VEZ',
],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '****530646',
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'c8016d13-6e76-****-9bda-769383d11787',
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'PushTask',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'required' => true,
'$ref' => '#/components/schemas/PushTask',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '11747540****88320',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '159E4422-6624-****-8943-DFD98D34858C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"11747540****88320\\",\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\"\\n}","type":"json"}]',
],
'MassPushV2' => [
'summary' => '新版高级推送接口',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREemasBNY9P0',
'FEATUREemasTZ8VEZ',
],
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'IdempotentToken',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'maxLength' => 36,
'minLength' => 36,
],
],
[
'name' => 'PushTasks',
'in' => 'query',
'style' => 'json',
'schema' => [
'type' => 'array',
'items' => [
'required' => false,
'$ref' => '#/components/schemas/PushTask',
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'MessageIds' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidPeriod.ExceedDays',
'errorMessage' => 'The period between specified EndTime and StartTime exceeds %s days.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'FileNotExist',
'errorMessage' => 'The specified file does not exist.',
],
[
'errorCode' => 'IncorrectPassword',
'errorMessage' => 'The password is incorrect.',
],
[
'errorCode' => 'NotApnsCertificate',
'errorMessage' => 'The Certificate is not an APNs certificate.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
[
'errorCode' => 'SendSpeedNotSupported',
'errorMessage' => 'SendSpeed is not supported for specified Target.',
],
[
'errorCode' => 'SmsProfileConfigFailed',
'errorMessage' => 'Failed to configure SMS profile.',
],
[
'errorCode' => 'SmsProfileGetFailed',
'errorMessage' => 'Failed to get SMS profile.',
],
[
'errorCode' => 'SmsRoleAuthorizeFailed',
'errorMessage' => 'Failed to authorize SMS role.',
],
[
'errorCode' => 'SmsRoleUnauthorized',
'errorMessage' => 'The SMS role is unauthorized.',
],
[
'errorCode' => 'TagsNumberBeyondLimit',
'errorMessage' => 'The number of tags bound to this app exceeds the limit.',
],
[
'errorCode' => 'Invalid%s.LengthExceed',
'errorMessage' => 'The specified %s length cannot be greater than %s.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
[
'errorCode' => 'TargetNotSupported',
'errorMessage' => 'Target is not supported for batch push.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-****-8943-DFD98D34858C\\",\\n \\"MessageIds\\": [\\n \\"1091371886864****\\"\\n ]\\n}","type":"json"}]',
],
'CheckCertificate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '23267207',
'format' => 'int64',
'maximum' => '1000000000',
'minimum' => '0',
'required' => true,
'type' => 'integer',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
'type' => 'string',
],
'Android' => [
'description' => '',
'example' => 'false',
'type' => 'boolean',
],
'IOS' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
'ProductionCertInfo' => [
'description' => '',
'properties' => [
'Status' => [
'description' => '',
'example' => 'OK',
'type' => 'string',
],
'ExipreTime' => [
'description' => '',
'example' => '1764561600000',
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
'DevelopmentCertInfo' => [
'description' => '',
'properties' => [
'Status' => [
'description' => '',
'example' => 'EXPIRED',
'type' => 'string',
],
'ExipreTime' => [
'description' => '',
'example' => '1470024000000',
'format' => 'int64',
'type' => 'integer',
],
],
'type' => 'object',
],
],
'type' => 'object',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'PermissionDenied',
'errorMessage' => 'The specified AppKey is not authorized.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"Android\\": false,\\n \\"IOS\\": true,\\n \\"ProductionCertInfo\\": {\\n \\"Status\\": \\"OK\\",\\n \\"ExipreTime\\": 1764561600000\\n },\\n \\"DevelopmentCertInfo\\": {\\n \\"Status\\": \\"EXPIRED\\",\\n \\"ExipreTime\\": 1470024000000\\n }\\n}","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'QueryPushRecords' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '333526247',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-09-15T02:05:24Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2021-09-29T06:24:58Z',
],
],
[
'name' => 'PushType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'NOTICE',
'enum' => [
'MESSAGE',
'NOTICE',
],
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'DEVICE',
'enum' => [
'ACCOUNT',
'ALIAS',
'DEVICE',
'TAG',
'TBD',
'FILE',
'ALL',
],
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'API',
'enum' => [
'CONSOLE',
'API',
],
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'FFPpkmhCPm*****************xjk=',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '20',
],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10000',
'minimum' => '1',
'example' => '8',
'default' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'i91D***********kXIh/dVBEQ==',
],
'PageSize' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9B24B396-249D-55E4-8CA1-66C9B50BB734',
],
'Total' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '193',
],
'Page' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'PushInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'type' => 'string',
'example' => 'SENT',
],
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '510431',
],
'AppKey' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '333526247',
],
'DeviceType' => [
'description' => '',
'type' => 'string',
'example' => 'ANDROID',
],
'PushType' => [
'description' => '',
'type' => 'string',
'example' => 'NOTICE',
],
'Body' => [
'description' => '',
'type' => 'string',
'example' => 'abcd',
],
'Title' => [
'description' => '',
'type' => 'string',
'example' => 'sssss',
],
'Source' => [
'description' => '',
'type' => 'string',
'example' => 'DEVICE',
],
'PushTime' => [
'description' => '',
'type' => 'string',
'example' => '2021-09-15T02:05:24Z',
],
'Target' => [
'description' => '',
'type' => 'string',
'example' => 'DEVICE',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"i91D***********kXIh/dVBEQ==\\",\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"9B24B396-249D-55E4-8CA1-66C9B50BB734\\",\\n \\"Total\\": 193,\\n \\"Page\\": 11,\\n \\"PushInfos\\": {\\n \\"PushInfo\\": [\\n {\\n \\"Status\\": \\"SENT\\",\\n \\"MessageId\\": \\"510431\\",\\n \\"AppKey\\": 333526247,\\n \\"DeviceType\\": \\"ANDROID\\",\\n \\"PushType\\": \\"NOTICE\\",\\n \\"Body\\": \\"abcd\\",\\n \\"Title\\": \\"sssss\\",\\n \\"Source\\": \\"DEVICE\\",\\n \\"PushTime\\": \\"2021-09-15T02:05:24Z\\",\\n \\"Target\\": \\"DEVICE\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 20\\n \\n \\n 23419851\\n 云智能测试推送内容\\n ANDROID\\n 60**************\\n 2023-01-01T08:12:34Z\\n NOTICE\\n API\\n SENT\\n DEVICE\\n 通知标题\\n \\n \\n DCA3F8E3-8D6A-5492-B059-48F56B022D8E\\n 1\\n","errorExample":""}]',
],
'QueryDeviceStat' => [
'summary' => '设备新增与留存',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-28T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-29T00:00:00Z',
],
],
[
'name' => 'DeviceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'iOS',
'enum' => [
'iOS',
'ANDROID',
'ALL',
],
],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'TOTAL',
'enum' => [
'NEW',
'TOTAL',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => [
'description' => '',
'type' => 'string',
'example' => '2016-07-28T16:00:00Z',
],
'DeviceType' => [
'description' => '',
'type' => 'string',
'example' => 'iOS',
],
'Count' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppDeviceStats\\": {\\n \\"AppDeviceStat\\": [\\n {\\n \\"Time\\": \\"2016-07-28T16:00:00Z\\",\\n \\"DeviceType\\": \\"iOS\\",\\n \\"Count\\": 100\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n iOS\\n 90\\n \\n \\n \\n iOS\\n 100\\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryUniqueDeviceStat' => [
'summary' => '去重设备统计',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-25T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-26T00:00:00Z',
],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAY',
'enum' => [
'DAY',
'MONTH',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppDeviceStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppDeviceStat' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => [
'description' => '',
'type' => 'string',
'example' => '2016-07-25T00:00:00Z',
],
'Count' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppDeviceStats\\": {\\n \\"AppDeviceStat\\": [\\n {\\n \\"Time\\": \\"2016-07-25T00:00:00Z\\",\\n \\"Count\\": 100\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n \\n 100\\n \\n \\n \\n 100\\n \\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDeviceInfo' => [
'summary' => '查询设备详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23419851',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'a64ae296f3b04a58a05b30c9****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194',
],
'DeviceInfo' => [
'description' => '',
'type' => 'object',
'properties' => [
'Account' => [
'description' => '',
'type' => 'string',
'example' => 'test@aliyun.com',
],
'LastOnlineTime' => [
'description' => '',
'type' => 'string',
'example' => '2018-03-27T02:19:40Z',
],
'PhoneNumber' => [
'description' => '',
'type' => 'string',
'example' => '133********',
],
'PushEnabled' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'DeviceType' => [
'description' => '',
'type' => 'string',
'example' => 'iOS',
],
'DeviceId' => [
'description' => '',
'type' => 'string',
'example' => 'a64ae296f3b04a58a05b30c95****',
],
'Online' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'Tags' => [
'description' => '',
'type' => 'string',
'example' => 'test_tag,test_tag2',
],
'DeviceToken' => [
'description' => '',
'type' => 'string',
'example' => '5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df',
],
'Alias' => [
'description' => '',
'type' => 'string',
'example' => 'test_alias,test_alias2',
],
'Brand' => [
'type' => 'string',
],
'Model' => [
'type' => 'string',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\",\\n \\"DeviceInfo\\": {\\n \\"Account\\": \\"test@aliyun.com\\",\\n \\"LastOnlineTime\\": \\"2018-03-27T02:19:40Z\\",\\n \\"PhoneNumber\\": \\"133********\\",\\n \\"PushEnabled\\": true,\\n \\"DeviceType\\": \\"iOS\\",\\n \\"DeviceId\\": \\"a64ae296f3b04a58a05b30c95****\\",\\n \\"Online\\": false,\\n \\"Tags\\": \\"test_tag,test_tag2\\",\\n \\"DeviceToken\\": \\"5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df\\",\\n \\"Alias\\": \\"test_alias,test_alias2\\",\\n \\"Brand\\": \\"HUAWEI\\",\\n \\"Model\\": \\"VOG-AL00\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\n \\n test@aliyun.com\\n 2018-03-27T02:19:40Z\\n 133********\\n true\\n iOS\\n a64ae296f3b04a58a05b30c95****\\n false\\n test_tag,test_tag2\\n 5ecc7b4012aaa801b63******5543ccbda6b4930d09629e936e1ac4b762a7df\\n test_alias,test_alias2\\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPushStatByApp' => [
'summary' => 'App维度推送统计',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-25T00:00:00Z',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2016-07-29T00:00:00Z',
],
],
[
'name' => 'Granularity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DAY',
'enum' => [
'DAY',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'AppPushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AppPushStat' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Time' => [
'description' => '',
'type' => 'string',
'example' => '2016-07-25T00:00:00Z',
],
'DeletedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'OpenedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'SmsReceiveSuccessCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsSkipCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsReceiveFailedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsFailedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReceivedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'SentCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'SmsSentCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AcceptCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '120',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"AppPushStats\\": {\\n \\"AppPushStat\\": [\\n {\\n \\"Time\\": \\"2016-07-25T00:00:00Z\\",\\n \\"DeletedCount\\": 10,\\n \\"OpenedCount\\": 30,\\n \\"SmsReceiveSuccessCount\\": 0,\\n \\"SmsSkipCount\\": 0,\\n \\"SmsReceiveFailedCount\\": 0,\\n \\"SmsFailedCount\\": 0,\\n \\"ReceivedCount\\": 60,\\n \\"SentCount\\": 100,\\n \\"SmsSentCount\\": 0,\\n \\"AcceptCount\\": 120\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n \\n 120\\n 100\\n 60\\n 30\\n 10\\n \\n \\n \\n 120\\n 100\\n 60\\n 30\\n 10\\n \\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryPushStatByMsg' => [
'summary' => '任务维度推送统计',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '510427',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'CF195C34-98FB-491A-98D7-19CBC1FA880B',
],
'PushStats' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PushStat' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '510427',
],
'DeletedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'OpenedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'SmsReceiveSuccessCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsSkipCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsReceiveFailedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'SmsFailedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'ReceivedCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'SentCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'SmsSentCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'AcceptCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '120',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CF195C34-98FB-491A-98D7-19CBC1FA880B\\",\\n \\"PushStats\\": {\\n \\"PushStat\\": [\\n {\\n \\"MessageId\\": \\"510427\\",\\n \\"DeletedCount\\": 10,\\n \\"OpenedCount\\": 30,\\n \\"SmsReceiveSuccessCount\\": 0,\\n \\"SmsSkipCount\\": 0,\\n \\"SmsReceiveFailedCount\\": 0,\\n \\"SmsFailedCount\\": 0,\\n \\"ReceivedCount\\": 60,\\n \\"SentCount\\": 100,\\n \\"SmsSentCount\\": 0,\\n \\"AcceptCount\\": 120\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n 510427\\n 120\\n 100\\n 60\\n 30\\n 10\\n \\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDevices' => [
'summary' => '批量检查设备有效性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '23419851',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'DeviceIds',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****,ae296f3b04a58a05b30c95f****',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
'type' => 'string',
],
'DeviceCheckInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceCheckInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'DeviceId' => [
'description' => '',
'example' => 'ae296f3b04a58a05b30c95f****',
'type' => 'string',
],
'Available' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
],
'type' => 'object',
],
],
],
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"DeviceCheckInfos\\": {\\n \\"DeviceCheckInfo\\": [\\n {\\n \\"DeviceId\\": \\"ae296f3b04a58a05b30c95f****\\",\\n \\"Available\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n true\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n true\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n false\\n \\n \\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'BindTag' => [
'summary' => '绑定标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test_tag,test_tag2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '82FD0A09-5BB8-40FB-8221-9A11FE92D620',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"82FD0A09-5BB8-40FB-8221-9A11FE92D620\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 82FD0A09-5BB8-40FB-8221-9A11FE92D620\\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindTag' => [
'summary' => '绑定标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test_tag1,test_tag2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveTag' => [
'summary' => '删除标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test_tag',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '23000F3C-0EFE-4C89-82EE-E04F42D37B3C',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23000F3C-0EFE-4C89-82EE-E04F42D37B3C\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTags' => [
'summary' => '查询标签列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'ClientKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b165576****',
],
],
[
'name' => 'KeyType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DEVICE',
'enum' => [
'DEVICE',
'ACCOUNT',
'ALIAS',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'D68AE5C6-8AAF-46C9-B627-3FDACD1A4168',
],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => '',
'type' => 'string',
'example' => 'test_tag2',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D68AE5C6-8AAF-46C9-B627-3FDACD1A4168\\",\\n \\"TagInfos\\": {\\n \\"TagInfo\\": [\\n {\\n \\"TagName\\": \\"test_tag2\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 1197FEB8-3644-4355-A96D-E332F45470EA\\n \\n \\n test_tag2\\n \\n \\n test_tag1\\n \\n \\n","errorExample":""}]',
],
'ListTags' => [
'summary' => '获取标签列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6EEF262B-EA7D-41DC-89B9-20F3D1E28194',
],
'TagInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => [
'description' => '',
'type' => 'string',
'example' => 'test_tag2',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
500 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6EEF262B-EA7D-41DC-89B9-20F3D1E28194\\",\\n \\"TagInfos\\": {\\n \\"TagInfo\\": [\\n {\\n \\"TagName\\": \\"test_tag2\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindAlias' => [
'summary' => '绑定别名',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'e2ba19de97604f55b16557673****',
],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'test_alias',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.BytesExceed',
'errorMessage' => 'The specified %s exceeds the %s bytes limit.',
],
[
'errorCode' => 'AccountDisabled',
'errorMessage' => 'Your account is not enabled.',
],
[
'errorCode' => 'Invalid%s.NotFound',
'errorMessage' => 'The specified %s is not found.',
],
],
500 => [
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 159E4422-6624-4750-8943-DFD98D34858C\\n","errorExample":""}]',
],
'UnbindAlias' => [
'summary' => '解绑别名',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '23267207',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'e2ba19de97604f55b16557673****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'test_alias',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'UnbindAll',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'true',
'required' => false,
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 82FD0A09-5BB8-40FB-8221-9A11FE92D620\\n","errorExample":""}]',
],
'QueryAliases' => [
'summary' => '查询别名',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '23267207',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'e2ba19de97604f55b165576****',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '159E4422-6624-4750-8943-DFD98D34858C',
'type' => 'string',
],
'AliasInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AliasInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'AliasName' => [
'description' => '',
'example' => 'test_alias1',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"159E4422-6624-4750-8943-DFD98D34858C\\",\\n \\"AliasInfos\\": {\\n \\"AliasInfo\\": [\\n {\\n \\"AliasName\\": \\"test_alias1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 159E4422-6624-4750-8943-DFD98D34858C\\n \\n test_alias1\\n \\n","errorExample":""}]',
],
'QueryDevicesByAlias' => [
'summary' => '通过别名查询设备列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Alias',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'aliasName',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'f6e43770afb944a1a879b4613****',
],
],
],
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '6A9FD644-35A5-40E4-89B0-2021CAEDC1B4',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b4613****\\"\\n ]\\n },\\n \\"RequestId\\": \\"6A9FD644-35A5-40E4-89B0-2021CAEDC1B4\\"\\n}","type":"json"}]',
],
'QueryDevicesByAccount' => [
'summary' => '通过账户查询设备列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Account',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'accountName',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0',
],
'DeviceIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DeviceId' => [
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'f6e43770afb944a1a879b46130ZZ****',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'AccountLimitExceed',
'errorMessage' => 'The number of devices bound to the account exceeds 10000.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A8A24108-2AD0-4F6E-81C7-A8A24C2C2AD0\\",\\n \\"DeviceIds\\": {\\n \\"DeviceId\\": [\\n \\"f6e43770afb944a1a879b46130ZZ****\\"\\n ]\\n }\\n}","type":"json"}]',
],
'BindPhone' => [
'summary' => '绑定手机号码',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'enumValueTitles' => [
23793506 => '23793506',
24738888 => '24738888',
27725900 => '27725900',
27819095 => '27819095',
],
'example' => '27725900',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'abcdef1d83d04d34807d229999eefa52' => 'abcdef1d83d04d34807d229999eefa52',
],
'example' => 'eb5f741d83d04d34807d229999eefa52',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
23456789102 => '23456789102',
],
'example' => '1381111****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0D1126F0-F8FF-513D-BAFA-F140447BDED4\\n","errorExample":""}]',
],
'UnbindPhone' => [
'summary' => '解绑手机号码',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eb5f741d83d04d34807d229999eefa52',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '0D1126F0-F8FF-513D-BAFA-F140447BDED4',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D1126F0-F8FF-513D-BAFA-F140447BDED4\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0D1126F0-F8FF-513D-BAFA-F140447BDED4\\n","errorExample":""}]',
],
'PushMessageToiOS' => [
'summary' => '推送消息给iOS设备',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '24780725',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'all',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'my title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'my body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushNoticeToiOS' => [
'summary' => '推送通知给iOS设备',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '24780725',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
],
],
[
'name' => 'ApnsEnv',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'DEV',
'enum' => [
'DEV',
'PRODUCT',
],
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'Hello World',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"k1":"ios","k2":"v2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '501029',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"RequestId\\": \\"501029\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushNoticeToAndroid' => [
'summary' => '推送通知给Android设备',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
[
'name' => 'ExtParameters',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '{"key1":"value1","api_name":"PushNoticeToAndroidRequest"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PushMessageToAndroid' => [
'summary' => '推送消息给Android设备',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23267207',
],
],
[
'name' => 'Target',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ALL',
'enum' => [
'ALL',
'DEVICE',
'ACCOUNT',
'ALIAS',
'TAG',
],
],
],
[
'name' => 'TargetValue',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'all',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'my title',
],
],
[
'name' => 'Body',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'my body',
],
],
[
'name' => 'StoreOffline',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
[
'name' => 'JobKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MessageId' => [
'description' => '',
'type' => 'string',
'example' => '501029',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Invalid%s.Format',
'errorMessage' => 'The specified %s format is invalid.',
],
[
'errorCode' => 'Invalid%s.Empty',
'errorMessage' => 'The specified %s cannot be empty.',
],
[
'errorCode' => 'Invalid.Parameter',
'errorMessage' => 'The specified parameter is invalid: %s.',
],
],
500 => [
[
'errorCode' => 'Timeout',
'errorMessage' => 'The request processing is timeout.',
],
[
'errorCode' => 'InternalError',
'errorMessage' => 'The request processing has failed due to some unknown error. Please try again. If the error still exists, submit a ticket.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MessageId\\": \\"501029\\",\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","type":"json"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDevice' => [
'summary' => '【废弃】验证设备有效性',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'AppKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '23419851',
],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ae296f3b04a58a05b30c95f****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Available' => [
'description' => '',
'type' => 'boolean',
'example' => 'ture',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Push::2016-08-01::CheckDevices',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Available\\": true,\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n true\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n true\\n \\n \\n ae296f3b04a58a05b30c95f1****\\n false\\n \\n \\n","errorExample":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSummaryApps' => [
'summary' => '【废弃】查询用户已创建的app列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREemasASSZZG',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC',
],
'SummaryAppInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SummaryAppInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppKey' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '23****07',
],
'AppName' => [
'description' => '',
'type' => 'string',
'example' => 'abc',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'substitutions' => [
'Mhub::2017-08-25::ListApps',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\",\\n \\"SummaryAppInfos\\": {\\n \\"SummaryAppInfo\\": [\\n {\\n \\"AppKey\\": 0,\\n \\"AppName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 9998B3CC-ED9E-4CB3-A8FB-DCC61296BFBC\\n \\n abc\\n \\n","errorExample":""}]',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-northeast-2-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-south-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-2',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-gov-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-nu16-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-edge-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-fujian',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-haidian-cm12-c01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-bj-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-prod-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-2',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-internal-test-3',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-test-306',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong-finance-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-north-2-gov-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao-nebula',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et15-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-et2-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-inner',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-internal-test-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-inner',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-st4-d01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-su18-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-wuhan',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-yushanfang',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangbei-na61-b01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou-na62-a01',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'cn-zhengzhou-nebula-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'eu-west-1-oxs',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'rus-west-1-pop',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'cloudpush.aliyuncs.com',
],
],
];