# 消息接口

## 发送验证码

> 说明：发送验证码。\<b style="color:red">根据每种业务类型（\`bizType\`）和发送人（\`toUser\`/\`customerNo\`）,半小时内只允许发送5次短信、5次邮件\</b>\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.VerificationApiService.verifyCodeSend\
> \`\`\`\
> \`\`\`\
> 开启人机校验\
> version=0.0.2\
> bizType=message.app.VerificationApiService.verifyCodeSend\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.VerificationApiService.verifyCodeSend":{"post":{"summary":"发送验证码","deprecated":false,"description":"说明：发送验证码。<b style=\"color:red\">根据每种业务类型（`bizType`）和发送人（`toUser`/`customerNo`）,半小时内只允许发送5次短信、5次邮件</b>\n```\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeSend\n```\n```\n开启人机校验\nversion=0.0.2\nbizType=message.app.VerificationApiService.verifyCodeSend\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id","description":"公司Id"},"customerId":{"type":"integer","format":"long","title":"客户Id","description":"客户Id"},"bizType":{"type":"string","title":"业务类型","description":"业务类型。EMAIL_COMMON_VERIFICATION_CODE-邮件通用验证码；EMAIL_LOGIN_VERIFICATION_CODE-邮件登录验证码；EMAIL_REGISTER_VERIFICATION_CODE-邮件注册验证码；EMAIL_PASSWORD_VERIFICATION_CODE-邮件忘记密码验证码；EMAIL_LOGINED_VERIFICATION_CODE-通用验证码-已登录-客户信息中获取接收人；SMS_COMMON_VERIFICATION_CODE-短信通用验证码；SMS_LOGIN_VERIFICATION_CODE-短信登录验证码；SMS_REGISTER_VERIFICATION_CODE-短信注册验证码；SMS_PASSWORD_VERIFICATION_CODE-短信忘记密码验证码；SMS_LOGINED_VERIFICATION_CODE-通用验证码-已登录-客户信息中获取接收人；SMS_TELEGRAM_VERIFICATION_CODE-短信telegram验证码；"},"toUser":{"type":"string","title":"接收人","description":"接收人。`toUser`、`customerNo`必须有一个要填：如果需要从客户信息里获取则传`customerNo`, 如果是发送telegram验证码就传第三方userId"},"customerNo":{"type":"string","title":"接收人","description":"接收人。`toUser`、`customerNo`必须有一个要填：如果需要从客户信息里获取则传`customerNo`"},"country":{"type":"string","description":"接收人所在国家信息"}},"required":["companyId","bizType"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{"token":{"type":"string","title":"发送票据","description":"发送票据"}},"title":"数据体","description":"数据体"}}}}},"headers":{}}}}}}}
````

## 验证验证码

> 说明：验证验证码\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.VerificationApiService.verifyCodeCheck\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.VerificationApiService.verifyCodeCheck":{"post":{"summary":"验证验证码","deprecated":false,"description":"说明：验证验证码\n```\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeCheck\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id","description":"公司Id"},"customerId":{"type":"integer","format":"long","title":"客户Id","description":"客户Id"},"bizType":{"type":"string","title":"业务类型","description":"业务类型。EMAIL_COMMON_VERIFICATION_CODE-邮件通用验证码；EMAIL_LOGIN_VERIFICATION_CODE-邮件登录验证码；EMAIL_REGISTER_VERIFICATION_CODE-邮件注册验证码；EMAIL_PASSWORD_VERIFICATION_CODE-邮件忘记密码验证码；EMAIL_LOGINED_VERIFICATION_CODE-通用验证码-已登录-客户信息中获取接收人；SMS_COMMON_VERIFICATION_CODE-短信通用验证码；SMS_LOGIN_VERIFICATION_CODE-短信登录验证码；SMS_REGISTER_VERIFICATION_CODE-短信注册验证码；SMS_PASSWORD_VERIFICATION_CODE-短信忘记密码验证码；SMS_LOGINED_VERIFICATION_CODE-通用验证码-已登录-客户信息中获取接收人；"},"toUser":{"type":"string","title":"接收人","description":"接收人"},"sendToken":{"type":"string","title":"发送票据","description":"发送票据"},"code":{"type":"string","title":"验证码","description":"验证码。仅可使用一次，与`verifyCodeToken`必须至少有一个有值"},"verifyCodeToken":{"type":"string","title":"验证票据","description":"验证票据。由首次验证验证码后返回。（与`code`必须至少有一个有值，如与`code`同时有值，仅验证此字段）。<b style=\"color:red\">注：验证5次错误，验证票据将直接失效</b>"}},"required":["companyId","bizType","toUser","sendToken"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{"token":{"type":"string","title":"验证票据","description":"验证票据"}},"title":"数据体","description":"数据体"}}}}},"headers":{}}}}}}}
````

## 站内信类型

> 说明：获取指定公司下站内信类型列表\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList":{"post":{"summary":"站内信类型","deprecated":false,"description":"说明：获取指定公司下站内信类型列表\n```\nversion=0.0.1\nbizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","title":"类型值"},"desc":{"type":"string","title":"描述"}},"required":["desc"]},"title":"数据体"}}}}},"headers":{}}}}}}}
````

## 站内信列表

> 说明：获取指定公司下站内信消息列表\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList":{"post":{"summary":"站内信列表","deprecated":false,"description":"说明：获取指定公司下站内信消息列表\n```\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"},"bizType":{"type":"string","title":"业务类型"},"status":{"type":"integer","format":"int32","title":"状态","description":"1-未读；2-已读；3-删除；"},"language":{"type":"string","title":"语种"},"accountId":{"type":"integer","format":"long","title":"账户ID"},"customerId":{"type":"integer","format":"long","title":"客户ID"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"bizType":{"type":"string","title":"业务类型"},"status":{"type":"string","title":"状态","description":"1-未读；2-已读；3-删除；"},"title":{"type":"string","title":"标题"},"content":{"type":"string","title":"内容"},"redirectType":{"type":"string","title":"跳转类型","description":"*"},"redirectUrl":{"type":"string","title":"跳转地址","description":"*"},"createdBy":{"type":"string","title":"创建人"}}},"title":"数据体"}}}}},"headers":{}}}}}}}
````

## 公告列表

> 说明： 查询公告列表\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.CompanyNoticeApiService.customerViewNoticePage\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewNoticePage":{"post":{"summary":"公告列表","deprecated":false,"description":"说明： 查询公告列表\n```\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewNoticePage\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id","description":"公司Id"},"customerNo":{"type":"string","title":"客户编号","description":"客户编号"},"lang":{"type":"string","title":"语种","description":"语种"},"size":{"type":"integer","format":"long","title":"每页条数","description":"每页条数"},"current":{"type":"integer","format":"long","title":"当前页，从1开始","description":"当前页，从1开始"},"pubTimeFrom":{"type":"integer","title":"发布时间-开始","format":"long","description":"发布时间-开始。13位时间戳"},"pubTimeTo":{"type":"integer","title":"发布时间-结束","format":"long","description":"发布时间-结束。13位时间戳"}},"required":["companyId","lang","size","current"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"名称","description":"名称"},"language":{"type":"string","title":"语种","description":"语种"},"title":{"type":"string","title":"标题","description":"标题"},"content":{"type":"string","title":"内容","description":"内容"},"pubTime":{"type":"integer","title":"发布时间","format":"long","description":"发布时间。13位时间戳"},"id":{"type":"integer","title":"主键id","format":"long","description":"主键id"},"companyId":{"type":"integer","title":"公司ID","format":"long","description":"公司ID"},"customerNo":{"type":"string","title":"客户编号","description":"客户编号"}}},"title":"数据体","description":"数据体"}}}}},"headers":{}}}}}}}
````

## 消息列表

> 说明： 客户查看消息列表\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.CompanyNoticeApiService.customerViewMsgPage\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewMsgPage":{"post":{"summary":"消息列表","deprecated":false,"description":"说明： 客户查看消息列表\n```\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewMsgPage\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"},"customerNo":{"type":"string","title":"客户编号"},"lang":{"type":"string","title":"语种"},"size":{"type":"integer","format":"long","title":"每页条数"},"current":{"type":"integer","format":"long","title":"当前页，从1开始"},"pubTimeFrom":{"type":"integer","title":"发布时间-开始","format":"long","description":"13位时间戳"},"pubTimeTo":{"type":"integer","title":"发布时间-结束","format":"long","description":"13位时间戳"}},"required":["companyId","lang","size","current","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"名称"},"language":{"type":"string","title":"语种"},"title":{"type":"string","title":"标题"},"content":{"type":"string","title":"内容"},"pubTime":{"type":"integer","title":"发布时间","format":"long","description":"13位时间戳"},"id":{"type":"integer","title":"主键id","format":"long"},"companyId":{"type":"integer","title":"公司ID","format":"long"},"customerNo":{"type":"string","title":"客户编号"},"readStatus":{"type":"string","title":"读取状态","description":"1-未读；2-已读；"}}},"title":"数据体"}}}}},"headers":{}}}}}}}
````

## 读消息

> 说明： 客户读消息\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.CompanyNoticeApiService.msgRead\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgRead":{"post":{"summary":"读消息","deprecated":false,"description":"说明： 客户读消息\n```\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgRead\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"},"customerNo":{"type":"string","title":"客户编号"},"id":{"type":"integer","format":"long","title":"消息ID"}},"required":["companyId","customerNo","id"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{},"title":"数据体"}}}}},"headers":{}}}}}}}
````

## 消息全部已读

> 说明：客户消息全部已读\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.CompanyNoticeApiService.msgAllRead\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgAllRead":{"post":{"summary":"消息全部已读","deprecated":false,"description":"说明：客户消息全部已读\n```\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgAllRead\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"},"customerNo":{"type":"string","title":"客户编号"}},"required":["companyId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{},"title":"数据体"}}}}},"headers":{}}}}}}}
````

## unipush账户绑定

> 说明：unipush账户绑定clientId\
> \`\`\`\
> bizType=messagepush.app.OfflinePushService.clientIdBindCustomer\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/messagepush.app.OfflinePushService.clientIdBindCustomer":{"post":{"summary":"unipush账户绑定","deprecated":false,"description":"说明：unipush账户绑定clientId\n```\nbizType=messagepush.app.OfflinePushService.clientIdBindCustomer\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id"},"customerId":{"type":"integer","title":"客户id","format":"long"},"clientId":{"type":"string","title":"个推客户id"}},"required":["companyId","clientId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码"},"code":{"type":"string","title":"状态返回码"},"msg":{"type":"string","title":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"boolean","title":"数据体","description":"true-成功；false-失败；"}}}}},"headers":{}}}}}}}
````

## 分页查询站内信消息记录

> 说明：分页查询渠道消息模板列表\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage":{"post":{"summary":"分页查询站内信消息记录","deprecated":false,"description":"说明：分页查询渠道消息模板列表\n```\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id","description":"公司Id"},"bizType":{"type":"string","title":"业务类型","description":"业务类型"},"status":{"type":"integer","format":"int32","title":"状态","description":"状态。1-未读；2-已读；3-删除；"},"language":{"type":"string","title":"语种","description":"语种"},"accountId":{"type":"integer","format":"long","title":"账户ID","description":"账户ID"},"type":{"type":"integer","format":"int32","title":"类型","description":"类型"},"title":{"type":"string","title":"标题","description":"标题"},"parentType":{"type":"string","title":"总类型","description":"总类型"},"customerId":{"type":"integer","format":"long","title":"客户ID","description":"客户ID"},"startSendTime":{"type":"integer","title":"开始发送时间","description":"开始发送时间","format":"long"},"endSendTime":{"type":"integer","title":"结束发送时间","description":"结束发送时间","format":"long"},"size":{"type":"integer","format":"long","title":"每页条数","description":"每页条数"},"current":{"type":"integer","format":"long","title":"当前页","description":"当前页"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","description":"公司ID","title":"公司ID"},"content":{"type":"string","title":"内容","description":"内容"},"createdBy":{"type":"string","title":"创建人","description":"创建人"},"createTime":{"type":"integer","format":"long","title":"创建时间","description":"创建时间"},"customerId":{"type":"integer","format":"long","title":"客户ID","description":"客户ID"},"readStatus":{"type":"string","description":"读取状态 1-未读；2-已读；3-删除；","title":"读取状态 1-未读；2-已读；"},"title":{"type":"string","title":"标题","description":"标题"},"updateBy":{"type":"string","title":"更新人","description":"更新人"},"updateTime":{"type":"string","title":"更新时间","description":"更新时间"},"customerNo":{"type":"string","title":"客户编号","description":"客户编号"}}},"title":"数据体","description":"数据体"}}}}},"headers":{}}}}}}}
````

## 发送联系我们邮件消息

> 说明：发送联系我们信息\
> \`\`\`\
> version=0.0.1\
> bizType=message.app.CompanyNoticeApiService.sendContactUsMsg\
> \`\`\`

````json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.sendContactUsMsg":{"post":{"summary":"发送联系我们邮件消息","deprecated":false,"description":"说明：发送联系我们信息\n```\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.sendContactUsMsg\n```","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"token","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"","required":false,"schema":{"type":"string"}},{"name":"version","in":"header","description":"","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","title":"公司Id","description":"公司Id"},"name":{"type":"string","title":"业务类型","description":"名称"},"email":{"type":"string","title":"接收人","description":"邮箱"},"message":{"type":"string","title":"接收人","description":"内容"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"ok":{"type":"boolean"},"fail":{"type":"boolean"}}}}},"headers":{}}}}}}}
````

## 获取token

> 此接口用于客户接入Openapi时，需要订阅账户、持仓、交易推送消息时申请消息订阅的鉴权Token

```json
{"openapi":"3.0.1","info":{"title":"默认模块","version":"1.0.0"},"tags":[{"name":"消息接口"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/getMsgPushToken":{"post":{"summary":"获取token","deprecated":false,"description":"此接口用于客户接入Openapi时，需要订阅账户、持仓、交易推送消息时申请消息订阅的鉴权Token","tags":["消息接口"],"parameters":[{"name":"companyId","in":"header","description":"公司ID","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Trace","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"语言","required":false,"schema":{"type":"string"}},{"name":"recvWindow","in":"header","description":"时间窗口","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"header","description":"apiKey","required":false,"schema":{"type":"string"}},{"name":"signature","in":"header","description":"签名","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"模块标识码","description":"模块标识码"},"code":{"type":"string","title":"状态返回码","description":"状态返回码"},"msg":{"type":"string","title":"状态描述","description":"状态描述"},"tm":{"type":"integer","format":"int64","title":"处理时长（毫秒）","description":"处理时长（毫秒）"},"trace":{"type":"string","title":"跟踪码","description":"跟踪码"},"msgParams":{"type":"string","title":"返回描述中占位符参数串，多个参数间以,分割","description":"返回描述中占位符参数串，多个参数间以,分割"},"data":{"type":"string","title":"Msg Token","description":"Msg Token"}},"required":["data"]}}},"headers":{}}}}}}}
```