HomeGitHub

消息接口

发送验证码

post

说明：发送验证码。根据每种业务类型（bizType）和发送人（toUser/customerNo）,半小时内只允许发送5次短信、5次邮件

version=0.0.1
bizType=message.app.VerificationApiService.verifyCodeSend
开启人机校验
version=0.0.2
bizType=message.app.VerificationApiService.verifyCodeSend
Header parameters
companyIdstringOptionalExample: {{company}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired

公司Id

customerIdinteger · longOptional

客户Id

bizTypestringRequired

业务类型。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验证码；

toUserstringOptional

接收人。toUser、customerNo必须有一个要填：如果需要从客户信息里获取则传customerNo, 如果是发送telegram验证码就传第三方userId

customerNostringOptional

接收人。toUser、customerNo必须有一个要填：如果需要从客户信息里获取则传customerNo

countrystringOptional

接收人所在国家信息

Responses
200Success
application/json
post
/global/message.app.VerificationApiService.verifyCodeSend
POST /api/global/message.app.VerificationApiService.verifyCodeSend HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 103

{
  "companyId": 39,
  "bizType": "EMAIL_PASSWORD_VERIFICATION_CODE",
  "toUser": "[email protected]",
  "customerId": 88
}
200Success
{
  "msg": "Success",
  "fail": false,
  "trace": "x-45c2ptm3-u5p98t3-gf1b2x-9pbyl41-1678691805",
  "code": "0",
  "data": {
    "token": "38caf08b-fafd-4cb5-b36c-ebdd1878b974"
  },
  "bizCode": "",
  "tm": 34,
  "msgParams": null,
  "ok": true
}

验证验证码

post

说明：验证验证码

version=0.0.1
bizType=message.app.VerificationApiService.verifyCodeCheck
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired

公司Id

customerIdinteger · longOptional

客户Id

bizTypestringRequired

业务类型。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-通用验证码-已登录-客户信息中获取接收人；

toUserstringRequired

接收人

sendTokenstringRequired

发送票据

codestringOptional

验证码。仅可使用一次，与verifyCodeToken必须至少有一个有值

verifyCodeTokenstringOptional

验证票据。由首次验证验证码后返回。（与code必须至少有一个有值，如与code同时有值，仅验证此字段）。注：验证5次错误，验证票据将直接失效

Responses
200Success
application/json
post
/global/message.app.VerificationApiService.verifyCodeCheck
POST /api/global/message.app.VerificationApiService.verifyCodeCheck HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "companyId": 12,
  "bizType": "sit sint ut sed occaecat",
  "toUser": "in",
  "sendToken": "fugiat ipsum occaecat",
  "customerId": 49,
  "code": "53",
  "verifyCodeToken": "95"
}
200Success
{
  "msg": "Success",
  "fail": false,
  "trace": "x-71o574-2tn5hk-pkj44361-3612md-1678691829",
  "code": "0",
  "data": {
    "token": "647a8a53-b97c-4d4a-b936-ffdce2096ad6"
  },
  "bizCode": "",
  "tm": 10,
  "msgParams": null,
  "ok": true
}

站内信类型

post

说明：获取指定公司下站内信类型列表

version=0.0.1
bizType=message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
Responses
200Success
application/json
post
/global/message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList
POST /api/global/message.app.PlatFormMessageTempApiService.getPlatformTempParentTypeList HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "companyId": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": [
    {
      "type": "text",
      "desc": "text"
    }
  ]
}

站内信列表

post

说明：获取指定公司下站内信消息列表

version=0.0.1
bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
bizTypestringOptional
statusinteger · int32Optional

1-未读；2-已读；3-删除；

languagestringOptional
accountIdinteger · longOptional
customerIdinteger · longOptional
Responses
200Success
application/json
post
/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList
POST /api/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogList HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "companyId": 1,
  "bizType": "text",
  "status": 1,
  "language": "text",
  "accountId": 1,
  "customerId": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": [
    {
      "bizType": "text",
      "status": "text",
      "title": "text",
      "content": "text",
      "redirectType": "text",
      "redirectUrl": "text",
      "createdBy": "text"
    }
  ]
}

公告列表

post

说明： 查询公告列表

version=0.0.1
bizType=message.app.CompanyNoticeApiService.customerViewNoticePage
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired

公司Id

customerNostringOptional

客户编号

langstringRequired

语种

sizeinteger · longRequired

每页条数

currentinteger · longRequired

当前页，从1开始

pubTimeFrominteger · longOptional

发布时间-开始。13位时间戳

pubTimeTointeger · longOptional

发布时间-结束。13位时间戳

Responses
200Success
application/json
post
/global/message.app.CompanyNoticeApiService.customerViewNoticePage
POST /api/global/message.app.CompanyNoticeApiService.customerViewNoticePage HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "companyId": 1,
  "customerNo": "text",
  "lang": "text",
  "size": 1,
  "current": 1,
  "pubTimeFrom": 1,
  "pubTimeTo": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": [
    {
      "name": "text",
      "language": "text",
      "title": "text",
      "content": "text",
      "pubTime": 1,
      "id": 1,
      "companyId": 1,
      "customerNo": "text"
    }
  ]
}

消息列表

post

说明： 客户查看消息列表

version=0.0.1
bizType=message.app.CompanyNoticeApiService.customerViewMsgPage
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
customerNostringRequired
langstringRequired
sizeinteger · longRequired
currentinteger · longRequired
pubTimeFrominteger · longOptional

13位时间戳

pubTimeTointeger · longOptional

13位时间戳

Responses
200Success
application/json
post
/global/message.app.CompanyNoticeApiService.customerViewMsgPage
POST /api/global/message.app.CompanyNoticeApiService.customerViewMsgPage HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "companyId": 1,
  "customerNo": "text",
  "lang": "text",
  "size": 1,
  "current": 1,
  "pubTimeFrom": 1,
  "pubTimeTo": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": [
    {
      "name": "text",
      "language": "text",
      "title": "text",
      "content": "text",
      "pubTime": 1,
      "id": 1,
      "companyId": 1,
      "customerNo": "text",
      "readStatus": "text"
    }
  ]
}

读消息

post

说明： 客户读消息

version=0.0.1
bizType=message.app.CompanyNoticeApiService.msgRead
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
customerNostringRequired
idinteger · longRequired
Responses
200Success
application/json
post
/global/message.app.CompanyNoticeApiService.msgRead
POST /api/global/message.app.CompanyNoticeApiService.msgRead HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "companyId": 1,
  "customerNo": "text",
  "id": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": {}
}

消息全部已读

post

说明：客户消息全部已读

version=0.0.1
bizType=message.app.CompanyNoticeApiService.msgAllRead
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
customerNostringRequired
Responses
200Success
application/json
post
/global/message.app.CompanyNoticeApiService.msgAllRead
POST /api/global/message.app.CompanyNoticeApiService.msgAllRead HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "companyId": 1,
  "customerNo": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": {}
}

unipush账户绑定

post

说明：unipush账户绑定clientId

bizType=messagepush.app.OfflinePushService.clientIdBindCustomer
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired
customerIdinteger · longOptional
clientIdstringRequired
Responses
200Success
application/json
post
/global/messagepush.app.OfflinePushService.clientIdBindCustomer
POST /api/global/messagepush.app.OfflinePushService.clientIdBindCustomer HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "companyId": 1,
  "customerId": 1,
  "clientId": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": true
}

分页查询站内信消息记录

post

说明：分页查询渠道消息模板列表

version=0.0.1
bizType=message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired

公司Id

bizTypestringOptional

业务类型

statusinteger · int32Optional

状态。1-未读；2-已读；3-删除；

languagestringOptional

语种

accountIdinteger · longOptional

账户ID

typeinteger · int32Optional

类型

titlestringOptional

标题

parentTypestringOptional

总类型

customerIdinteger · longOptional

客户ID

startSendTimeinteger · longOptional

开始发送时间

endSendTimeinteger · longOptional

结束发送时间

sizeinteger · longOptional

每页条数

currentinteger · longOptional

当前页

Responses
200Success
application/json
post
/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage
POST /api/global/message.app.PlatFormMessageLogApiService.queryPlatFormMessageLogByPage HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "companyId": 1,
  "bizType": "text",
  "status": 1,
  "language": "text",
  "accountId": 1,
  "type": 1,
  "title": "text",
  "parentType": "text",
  "customerId": 1,
  "startSendTime": 1,
  "endSendTime": 1,
  "size": 1,
  "current": 1
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true,
  "data": [
    {
      "companyId": 1,
      "content": "text",
      "createdBy": "text",
      "createTime": 1,
      "customerId": 1,
      "readStatus": "text",
      "title": "text",
      "updateBy": "text",
      "updateTime": "text",
      "customerNo": "text"
    }
  ]
}

发送联系我们邮件消息

post

说明：发送联系我们信息

version=0.0.1
bizType=message.app.CompanyNoticeApiService.sendContactUsMsg
Header parameters
companyIdstringOptionalExample: {{company}}
tokenstringOptionalExample: {{LoginResult.data.token}}
langstringOptionalExample: en-US
tracestringOptionalExample: {{mock_trace}}
versionstringOptionalExample: 0.0.1
Body
companyIdinteger · longRequired

公司Id

namestringOptional

名称

emailstringOptional

邮箱

messagestringOptional

内容

Responses
200Success
application/json
post
/global/message.app.CompanyNoticeApiService.sendContactUsMsg
POST /api/global/message.app.CompanyNoticeApiService.sendContactUsMsg HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "companyId": 1,
  "name": "text",
  "email": "text",
  "message": "text"
}
200Success
{
  "bizCode": "text",
  "code": "text",
  "msg": "text",
  "tm": 1,
  "trace": "text",
  "msgParams": "text",
  "ok": true,
  "fail": true
}

获取token

post

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

Header parameters
companyIdstringOptional

公司ID

Example: {{company}}
tracestringOptional

Trace

Example: {{mock_trace}}
langstringOptional

语言

Example: zh-CN
recvWindowstringOptional

时间窗口

Example: 5000
apiKeystringOptional

apiKey

Example: {{apikey}}
signaturestringOptional

签名

Example: {{sign}}
Body
objectOptional
Responses
200Success
application/json
post
/global/getMsgPushToken
POST /api/global/getMsgPushToken HTTP/1.1
Host: prewppc-3.cmfbl.com
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
200Success
{
  "msg": "Success",
  "fail": false,
  "trace": "",
  "code": "0",
  "data": "6230de2c-281a-47fe-9d5d-b5f6ac60f482push",
  "bizCode": "",
  "tm": 0,
  "ok": true
}
Previous客户接口/代理相关Next消息接口/AllTick

Last updated