Message

Send verification code

post

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

Header parameters

companyIdstringOptionalExample: {{company}}

langstringOptionalExample: en-US

tracestringOptionalExample: {{mock_trace}}

versionstringOptionalExample: 0.0.1

Body

companyIdinteger · longRequired

Company Id

customerIdinteger · longOptional

Client Id

bizTypestringRequired

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;

toUserstringOptional

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

customerNostringOptional

Recipient. toUser, customerNo must have one to fill: if you need to get it from customer information, pass customerNo

countrystringOptional

Recipient's country information

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

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
}

Verify verification code

post

Description: Verify verification code

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

Company Id

customerIdinteger · longOptional

Client Id

bizTypestringRequired

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;

toUserstringRequired

Recipient

sendTokenstringRequired

Send ticket

codestringOptional

Verification code. Can only be used once, and at least one of verifyCodeToken must have a value

verifyCodeTokenstringOptional

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

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

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
}

Station message type

post

Explanation: Get the list of station message types under the specified company

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

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

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"
    }
  ]
}

Internal message list

post

Explanation: Get the message list of the specified company

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-Unread; 2-Read; 3-Delete;

languagestringOptional

accountIdinteger · longOptional

customerIdinteger · longOptional

Responses

200Success

application/json

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

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"
    }
  ]
}

Paging query station message records

post

Explanation: Paging query channel message template list

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

Company Id

bizTypestringOptional

Business type

statusinteger · int32Optional

Status. 1-Unread; 2-Read; 3-Deleted;

languagestringOptional

Language

accountIdinteger · longOptional

Account ID

typeinteger · int32Optional

Type

titlestringOptional

Title

parentTypestringOptional

Total type

customerIdinteger · longOptional

Client ID

startSendTimeinteger · longOptional

Start sending time

endSendTimeinteger · longOptional

End sending time

sizeinteger · longOptional

Number of Items per Page

currentinteger · longOptional

Current Page

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

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"
    }
  ]
}

Announcement list

post

Explanation: Query announcement list

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

Company Id

customerNostringOptional

Client number

langstringRequired

Language

sizeinteger · longRequired

Number of Items per Page

currentinteger · longRequired

Current page, starting from 1

pubTimeFrominteger · longOptional

Release time - start. 13-digit timestamp

pubTimeTointeger · longOptional

Release time - end. 13-digit timestamp

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

msgParamsstringOptional

Placeholder parameter string in return description, multiple parameters separated by commas

okbooleanOptional

failbooleanOptional

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"
    }
  ]
}

Message list

post

Explanation: Customers view message list

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-digit timestamp

pubTimeTointeger · longOptional

13-digit timestamp

Responses

200Success

application/json

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

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"
    }
  ]
}

Read message

post

Explanation: Customer reads message

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

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

dataobject · DataBodyOptional

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": {}
}

All messages read

post

Explanation: All customer messages have been read

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

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

dataobject · DataBodyOptional

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 account binding

post

Explanation: Unipush account binding 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

bizCodestringOptional

codestringOptional

msgstringOptional

tminteger · int64Optional

tracestringOptional

msgParamsstringOptional

okbooleanOptional

failbooleanOptional

databooleanOptional

true-success; false-failure;

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
}

Send Contact Us Email Message

post

Explanation: Send Contact Us Information

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

Company Id

namestringOptional

Name

emailstringOptional

messagestringOptional

Content

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

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"
}

get Msg Token

post

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.

Header parameters

companyIdstringOptional

company id

Example: {{company}}

tracestringOptional

Trace

Example: {{mock_trace}}

langstringOptional

language

Example: zh-CN

recvWindowstringOptional

Time window

Example: 5000

apiKeystringOptional

apiKey

Example: {{apikey}}

signaturestringOptional

signature

Example: {{sign}}

Body

objectOptional

Responses

200Success

application/json

bizCodestringOptional

Module identifier code

codestringOptional

Status return code

msgstringOptional

Status description

tminteger · int64Optional

Processing time (milliseconds)

tracestringOptional

Tracking code

datastringRequired

Msg Token

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
}

PreviousCustomer/Credit Card NextFunds/Deposit

Last updated 4 months ago

hashtagSend verification code

hashtagVerify verification code

hashtagStation message type

hashtagInternal message list

hashtagPaging query station message records

hashtagAnnouncement list

hashtagMessage list

hashtagRead message

hashtagAll messages read

hashtagUnipush account binding

hashtagSend Contact Us Email Message

hashtagget Msg Token

Send verification code

Verify verification code

Station message type

Internal message list

Paging query station message records

Announcement list

Message list

Read message

All messages read

Unipush account binding

Send Contact Us Email Message

get Msg Token