180 lines
5.4 KiB
JSON
180 lines
5.4 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"title": "mail.proto",
|
||
"version": "version not set"
|
||
},
|
||
"tags": [
|
||
{
|
||
"name": "Mail"
|
||
},
|
||
{
|
||
"name": "Xiaomi"
|
||
},
|
||
{
|
||
"name": "Sms"
|
||
}
|
||
],
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"paths": {},
|
||
"definitions": {
|
||
"notifyBaseItem": {
|
||
"type": "object",
|
||
"properties": {
|
||
"payload": {
|
||
"type": "string",
|
||
"title": "消息的内容。（注意:需要对payload字符串做urlencode处理）"
|
||
},
|
||
"restrictedPackageName": {
|
||
"type": "string",
|
||
"title": "App的包名。备注:中间用逗号分割。"
|
||
},
|
||
"title": {
|
||
"type": "string",
|
||
"title": "通知栏展示的通知的标题，不允许全是空白字符，长度小于50， 一个中英文字符均计算为1（通知栏消息必填）。"
|
||
},
|
||
"description": {
|
||
"type": "string",
|
||
"title": "通知栏展示的通知的描述，不允许全是空白字符，长度小于128，一个中英文字符均计算为1（通知栏消息必填）。"
|
||
},
|
||
"timeToLive": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "可选项。如果用户离线，设置消息在服务器保存的时间，单位:ms。服务器默认最长保留两周。"
|
||
},
|
||
"timeToSend": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "可选项。定时发送消息。用自1970年1月1日以来00:00:00.0 UTC时间表示（以毫秒为单位的时间）。注:仅支持七天内的定时消息。"
|
||
},
|
||
"soundUri": {
|
||
"type": "string",
|
||
"title": "可选项，自定义通知栏消息铃声url"
|
||
},
|
||
"notifyForeground": {
|
||
"type": "string",
|
||
"title": "可选项 '1'弹出通知栏消息(默认);'0'不会弹出通知栏消息"
|
||
},
|
||
"notifyEffect": {
|
||
"type": "string",
|
||
"title": "可选项，预定义通知栏消息的点击行为;\"1\":打开app的Launcher Activity。\"2\":打开app的任一Activity（需要extra.intent_uri）。\"3\":打开网页（需要传入extra.web_uri）"
|
||
},
|
||
"intentUri": {
|
||
"type": "string",
|
||
"title": "可选项，打开当前app的任一组件。"
|
||
},
|
||
"webUri": {
|
||
"type": "string",
|
||
"title": "可选项，打开某一个网页。"
|
||
},
|
||
"jobkey": {
|
||
"type": "string",
|
||
"title": "可选项，使用推送批次（JobKey）功能聚合消息。由数字（[0-9]），大小写字母（[a-zA-Z]），下划线（_）和中划线（-）组成，长度不大于20个字符"
|
||
},
|
||
"appVersion": {
|
||
"type": "string",
|
||
"title": "可以接收消息的app版本号，用逗号分割。目前支持MiPush_SDK_Client_2_2_12_sdk.jar（及以后）的版本。"
|
||
},
|
||
"appVersionNotIn": {
|
||
"type": "string",
|
||
"title": "无法接收消息的app版本号，用逗号分割。"
|
||
},
|
||
"connpt": {
|
||
"type": "string",
|
||
"title": "可选项，指定在特定的网络环境下才能接收到消息。目前仅支持指定\"wifi\"。"
|
||
},
|
||
"onlySendOnce": {
|
||
"type": "string",
|
||
"title": "可选项，extra.only_send_once的值设置为'1'，表示该消息仅在设备在线时发送一次，不缓存离线消息进行多次下发"
|
||
},
|
||
"notifyId": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"title": "可选项。默认情况下，通知栏只显示一条推送消息。如果通知栏要显示多条推送消息，需要针对不同的消息设置不同的notify_id（相同notify_id的通知栏消息会覆盖之前的），且要求notify_id为取值在0~2147483647的整数。"
|
||
}
|
||
}
|
||
},
|
||
"notifyPassResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"pass": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"notifySendMailResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"requestId": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"notifySmsSendResponse": {
|
||
"type": "object",
|
||
"properties": {
|
||
"bizId": {
|
||
"type": "string",
|
||
"title": "string request_id = 1;"
|
||
}
|
||
}
|
||
},
|
||
"notifyStatusReply": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "状态码"
|
||
},
|
||
"identity": {
|
||
"type": "string",
|
||
"title": "标识码"
|
||
},
|
||
"message": {
|
||
"type": "string",
|
||
"title": "状态说明"
|
||
},
|
||
"timeseq": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "响应时间序列"
|
||
}
|
||
}
|
||
},
|
||
"protobufAny": {
|
||
"type": "object",
|
||
"properties": {
|
||
"@type": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"additionalProperties": {}
|
||
},
|
||
"rpcStatus": {
|
||
"type": "object",
|
||
"properties": {
|
||
"code": {
|
||
"type": "integer",
|
||
"format": "int32"
|
||
},
|
||
"message": {
|
||
"type": "string"
|
||
},
|
||
"details": {
|
||
"type": "array",
|
||
"items": {
|
||
"type": "object",
|
||
"$ref": "#/definitions/protobufAny"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|