# Message ## Send verification code > Explanation: Send verification code. According to each business type (\`bizType\`) and sender (\`toUser\`/\`customerNo\`), only 5 SMS and 5 email messages are allowed within half an hour\ > \ > version=0.0.1\ > bizType=message.app.VerificationApiService.verifyCodeSend\ > \ > \ > Enable CAPTCHA\ > version=0.0.2\ > bizType=message.app.VerificationApiService.verifyCodeSend ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.VerificationApiService.verifyCodeSend":{"post":{"summary":"Send verification code","deprecated":false,"description":"Explanation: Send verification code. According to each business type (`bizType`) and sender (`toUser`/`customerNo`), only 5 SMS and 5 email messages are allowed within half an hour\n\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeSend\n\n\nEnable CAPTCHA\nversion=0.0.2\nbizType=message.app.VerificationApiService.verifyCodeSend","tags":["Message"],"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":"Company Id","description":"Company Id"},"customerId":{"type":"integer","format":"long","title":"Client Id","description":"Client Id"},"bizType":{"type":"string","title":"Business type","description":"Business type. EMAIL_COMMON_VERIFICATION_CODE-Email common verification code; EMAIL_LOGIN_VERIFICATION_CODE-Email login verification code; EMAIL_REGISTER_VERIFICATION_CODE-Email registration verification code; EMAIL_PASSWORD_VERIFICATION_CODE-Email forget password verification code; EMAIL_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from client information; SMS_COMMON_VERIFICATION_CODE-SMS common verification code; SMS_LOGIN_VERIFICATION_CODE-SMS login verification code; SMS_REGISTER_VERIFICATION_CODE-SMS registration verification code; SMS_PASSWORD_VERIFICATION_CODE-SMS forget password verification code; SMS_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from client information; SMS_TELEGRAM_VERIFICATION_CODE-SMS telegram verification code;"},"toUser":{"type":"string","title":"Recipient","description":"Recipient. `toUser`, `customerNo` must be filled in: if need to get from client information, fill in `customerNo`, if sending telegram verification code, fill in third party userId"},"customerNo":{"type":"string","title":"Recipient","description":"Recipient. `toUser`, `customerNo` must have one to fill: if you need to get it from customer information, pass `customerNo`"},"country":{"type":"string","description":"Recipient's country information"}},"required":["companyId","bizType"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{"token":{"type":"string","title":"Send ticket","description":"Send ticket"}},"title":"Data Body","description":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Verify verification code > Description: Verify verification code\ > \ > version=0.0.1\ > bizType=message.app.VerificationApiService.verifyCodeCheck ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.VerificationApiService.verifyCodeCheck":{"post":{"summary":"Verify verification code","deprecated":false,"description":"Description: Verify verification code\n\nversion=0.0.1\nbizType=message.app.VerificationApiService.verifyCodeCheck","tags":["Message"],"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":"Company Id","description":"Company Id"},"customerId":{"type":"integer","format":"long","title":"Client Id","description":"Client Id"},"bizType":{"type":"string","title":"Business type","description":"Business type. EMAIL_COMMON_VERIFICATION_CODE-Email common verification code; EMAIL_LOGIN_VERIFICATION_CODE-Email login verification code; EMAIL_REGISTER_VERIFICATION_CODE-Email registration verification code; EMAIL_PASSWORD_VERIFICATION_CODE-Email forget password verification code; EMAIL_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from customer information; SMS_COMMON_VERIFICATION_CODE-SMS common verification code; SMS_LOGIN_VERIFICATION_CODE-SMS login verification code; SMS_REGISTER_VERIFICATION_CODE-SMS registration verification code; SMS_PASSWORD_VERIFICATION_CODE-SMS forget password verification code; SMS_LOGINED_VERIFICATION_CODE-Common verification code-logged in-get recipient from customer information;"},"toUser":{"type":"string","title":"Recipient","description":"Recipient"},"sendToken":{"type":"string","title":"Send ticket","description":"Send ticket"},"code":{"type":"string","title":"Verification code","description":"Verification code. Can only be used once, and at least one of `verifyCodeToken` must have a value"},"verifyCodeToken":{"type":"string","title":"Validate Ticket","description":"Verification token. Returned after the first verification of the verification code. (At least one of `code` must have a value. If both `code` and `code` have values, only this field is verified). Note: If there are 5 verification errors, the verification token will be invalidated directly"}},"required":["companyId","bizType","toUser","sendToken"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{"token":{"type":"string","title":"Validate Ticket","description":"Validate Ticket"}},"title":"Data Body","description":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Station message type > Explanation: Get the list of station message types under the specified company\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList":{"post":{"summary":"Station message type","deprecated":false,"description":"Explanation: Get the list of station message types under the specified company\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList","tags":["Message"],"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":"Company Id"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","title":"Type value"},"desc":{"type":"string","title":"Description"}},"required":["desc"]},"title":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Internal message list > Explanation: Get the message list of the specified company\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList":{"post":{"summary":"Internal message list","deprecated":false,"description":"Explanation: Get the message list of the specified company\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList","tags":["Message"],"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":"Company Id"},"bizType":{"type":"string","title":"Business type"},"status":{"type":"integer","format":"int32","title":"Status","description":"1-Unread; 2-Read; 3-Delete;"},"language":{"type":"string","title":"Language"},"accountId":{"type":"integer","format":"long","title":"Account ID"},"customerId":{"type":"integer","format":"long","title":"Client ID"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"bizType":{"type":"string","title":"Business type"},"status":{"type":"string","title":"Status","description":"1-Unread; 2-Read; 3-Delete;"},"title":{"type":"string","title":"Title"},"content":{"type":"string","title":"Content"},"redirectType":{"type":"string","title":"Jump Type","description":"*"},"redirectUrl":{"type":"string","title":"Jump Address","description":"*"},"createdBy":{"type":"string","title":"Creator"}}},"title":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Paging query station message records > Explanation: Paging query channel message template list\ > \ > version=0.0.1\ > bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage":{"post":{"summary":"Paging query station message records","deprecated":false,"description":"Explanation: Paging query channel message template list\n\nversion=0.0.1\nbizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage","tags":["Message"],"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":"Company Id","description":"Company Id"},"bizType":{"type":"string","title":"Business type","description":"Business type"},"status":{"type":"integer","format":"int32","title":"Status","description":"Status. 1-Unread; 2-Read; 3-Deleted;"},"language":{"type":"string","title":"Language","description":"Language"},"accountId":{"type":"integer","format":"long","title":"Account ID","description":"Account ID"},"type":{"type":"integer","format":"int32","title":"Type","description":"Type"},"title":{"type":"string","title":"Title","description":"Title"},"parentType":{"type":"string","title":"Total type","description":"Total type"},"customerId":{"type":"integer","format":"long","title":"Client ID","description":"Client ID"},"startSendTime":{"type":"integer","title":"Start sending time","description":"Start sending time","format":"long"},"endSendTime":{"type":"integer","title":"End sending time","description":"End sending time","format":"long"},"size":{"type":"integer","format":"long","title":"Number of Items per Page","description":"Number of Items per Page"},"current":{"type":"integer","format":"long","title":"Current Page","description":"Current Page"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"companyId":{"type":"integer","format":"long","description":"Company ID","title":"Company ID"},"content":{"type":"string","title":"Content","description":"Content"},"createdBy":{"type":"string","title":"Creator","description":"Creator"},"createTime":{"type":"integer","format":"long","title":"Creation time","description":"Creation time"},"customerId":{"type":"integer","format":"long","title":"Client ID","description":"Client ID"},"readStatus":{"type":"string","description":"Read status 1-Unread; 2-Read; 3-Deleted;","title":"Read status 1-Unread; 2-Read;"},"title":{"type":"string","title":"Title","description":"Title"},"updateBy":{"type":"string","title":"Updater","description":"Updater"},"updateTime":{"type":"string","title":"Update Time","description":"Update Time"},"customerNo":{"type":"string","title":"Client number","description":"Client number"}}},"title":"Data Body","description":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Announcement list > Explanation: Query announcement list\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.customerViewNoticePage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewNoticePage":{"post":{"summary":"Announcement list","deprecated":false,"description":"Explanation: Query announcement list\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewNoticePage","tags":["Message"],"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":"Company Id","description":"Company Id"},"customerNo":{"type":"string","title":"Client number","description":"Client number"},"lang":{"type":"string","title":"Language","description":"Language"},"size":{"type":"integer","format":"long","title":"Number of Items per Page","description":"Number of Items per Page"},"current":{"type":"integer","format":"long","title":"Current page, starting from 1","description":"Current page, starting from 1"},"pubTimeFrom":{"type":"integer","title":"Release time - start","format":"long","description":"Release time - start. 13-digit timestamp"},"pubTimeTo":{"type":"integer","title":"Release time - end","format":"long","description":"Release time - end. 13-digit timestamp"}},"required":["companyId","lang","size","current"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas","description":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"Name","description":"Name"},"language":{"type":"string","title":"Language","description":"Language"},"title":{"type":"string","title":"Title","description":"Title"},"content":{"type":"string","title":"Content","description":"Content"},"pubTime":{"type":"integer","title":"Release time","format":"long","description":"Release time. 13-digit timestamp"},"id":{"type":"integer","title":"Primary key id","format":"long","description":"Primary key id"},"companyId":{"type":"integer","title":"Company ID","format":"long","description":"Company ID"},"customerNo":{"type":"string","title":"Client number","description":"Client number"}}},"title":"Data Body","description":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Message list > Explanation: Customers view message list\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.customerViewMsgPage ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.customerViewMsgPage":{"post":{"summary":"Message list","deprecated":false,"description":"Explanation: Customers view message list\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.customerViewMsgPage","tags":["Message"],"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":"Company Id"},"customerNo":{"type":"string","title":"Client number"},"lang":{"type":"string","title":"Language"},"size":{"type":"integer","format":"long","title":"Number of Items per Page"},"current":{"type":"integer","format":"long","title":"Current page, starting from 1"},"pubTimeFrom":{"type":"integer","title":"Release time - start","format":"long","description":"13-digit timestamp"},"pubTimeTo":{"type":"integer","title":"Release time - end","format":"long","description":"13-digit timestamp"}},"required":["companyId","lang","size","current","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","title":"Name"},"language":{"type":"string","title":"Language"},"title":{"type":"string","title":"Title"},"content":{"type":"string","title":"Content"},"pubTime":{"type":"integer","title":"Release time","format":"long","description":"13-digit timestamp"},"id":{"type":"integer","title":"Primary key id","format":"long"},"companyId":{"type":"integer","title":"Company ID","format":"long"},"customerNo":{"type":"string","title":"Client number"},"readStatus":{"type":"string","title":"Read status","description":"1-Unread; 2-Read;"}}},"title":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Read message > Explanation: Customer reads message\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.msgRead ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgRead":{"post":{"summary":"Read message","deprecated":false,"description":"Explanation: Customer reads message\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgRead","tags":["Message"],"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":"Company Id"},"customerNo":{"type":"string","title":"Client number"},"id":{"type":"integer","format":"long","title":"Message ID"}},"required":["companyId","customerNo","id"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{},"title":"Data Body"}}}}},"headers":{}}}}}}} ``` ## All messages read > Explanation: All customer messages have been read\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.msgAllRead ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.msgAllRead":{"post":{"summary":"All messages read","deprecated":false,"description":"Explanation: All customer messages have been read\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.msgAllRead","tags":["Message"],"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":"Company Id"},"customerNo":{"type":"string","title":"Client number"}},"required":["companyId","customerNo"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"object","properties":{},"title":"Data Body"}}}}},"headers":{}}}}}}} ``` ## Unipush account binding > Explanation: Unipush account binding clientId bizType=messagepush.app.OfflinePushService.clientIdBindCustomer ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/messagepush.app.OfflinePushService.clientIdBindCustomer":{"post":{"summary":"Unipush account binding","deprecated":false,"description":"Explanation: Unipush account binding clientId bizType=messagepush.app.OfflinePushService.clientIdBindCustomer","tags":["Message"],"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":"Company Id"},"customerId":{"type":"integer","title":"Customer ID","format":"long"},"clientId":{"type":"string","title":"Getui customer id"}},"required":["companyId","clientId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code"},"code":{"type":"string","title":"Status return code"},"msg":{"type":"string","title":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code"},"msgParams":{"type":"string","title":"Placeholder parameter string in return description, multiple parameters separated by commas"},"ok":{"type":"boolean"},"fail":{"type":"boolean"},"data":{"type":"boolean","title":"Data Body","description":"true-success; false-failure;"}}}}},"headers":{}}}}}}} ``` ## Send Contact Us Email Message > Explanation: Send Contact Us Information\ > \ > version=0.0.1\ > bizType=message.app.CompanyNoticeApiService.sendContactUsMsg ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/message.app.CompanyNoticeApiService.sendContactUsMsg":{"post":{"summary":"Send Contact Us Email Message","deprecated":false,"description":"Explanation: Send Contact Us Information\n\nversion=0.0.1\nbizType=message.app.CompanyNoticeApiService.sendContactUsMsg","tags":["Message"],"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":"Company Id","description":"Company Id"},"name":{"type":"string","title":"Business type","description":"Name"},"email":{"type":"string","title":"Recipient","description":"Email"},"message":{"type":"string","title":"Recipient","description":"Content"}},"required":["companyId"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"bizCode":{"type":"string","title":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"}}}}},"headers":{}}}}}}} ``` ## get Msg Token > This interface is used by customers to access OpenAPI and apply for the authentication token for message subscription when they need to subscribe to account, position, and transaction push messages. ```json {"openapi":"3.0.1","info":{"title":"Default module","version":"1.0.0"},"tags":[{"name":"Message"}],"servers":[{"url":"https://prewppc-3.cmfbl.com/api","description":"PRE测试公司439"}],"security":[],"paths":{"/global/getMsgPushToken":{"post":{"summary":"get Msg Token","deprecated":false,"description":"This interface is used by customers to access OpenAPI and apply for the authentication token for message subscription when they need to subscribe to account, position, and transaction push messages.","tags":["Message"],"parameters":[{"name":"companyId","in":"header","description":"company id","required":false,"schema":{"type":"string"}},{"name":"trace","in":"header","description":"Trace","required":false,"schema":{"type":"string"}},{"name":"lang","in":"header","description":"language","required":false,"schema":{"type":"string"}},{"name":"recvWindow","in":"header","description":"Time window","required":false,"schema":{"type":"string"}},{"name":"apiKey","in":"header","description":"apiKey","required":false,"schema":{"type":"string"}},{"name":"signature","in":"header","description":"signature","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":"Module identifier code","description":"Module identifier code"},"code":{"type":"string","title":"Status return code","description":"Status return code"},"msg":{"type":"string","title":"Status description","description":"Status description"},"tm":{"type":"integer","format":"int64","title":"Processing time (milliseconds)","description":"Processing time (milliseconds)"},"trace":{"type":"string","title":"Tracking code","description":"Tracking code"},"data":{"type":"string","description":"Msg Token"}},"required":["data"]}}},"headers":{}}}}}}} ```