Property

Data type

Required

Description

resultStatus

String

No

Result status. Valid values are:

• S : Successful.
• F : Failed.
• U : Unknown.
• A : accepted, not yet succeed, but can proceed with some actions.

resultCode

String 

No

Result code.

Max. length: 64 characters.

resultMessage

String

No

Result message that describes the result code in details.

Max. length: 256 characters.

Property

Data type

Required

Description

messageId

String 

Yes

The unique ID that identifies a message.

Max. length: 64 characters.

customerId

String 

Yes

The unique ID that is assigned by wallets to identify a customer.

Example: 218820000000000000023.

Max. length: 32 characters.

messageChannel

MessageChannel

Yes

The channel to send a message.

redirectUrl

String 

No

The Mini Program page that is redirected to after the user clicks the PUSH/INBOXmessage. Therefore, for the PUSH/INBOX message, this property is required.

Max. length: 1024 characters.

messageContent

JSON String 

Yes

The content of a message to send, for example: 

"{

"en-US": "Hello, World", 

"zh-CN":  "你好，世界"

}" 

Max. length: 4096 characters.

Property

Data type

Required

Description

messageId

String 

Yes

The unique ID that identifies a message.

Max. length: 64 characters.

success

Boolean

Yes

Indicates whether the message is sent successfully or not.

• true : the message is sent successfully.
• false : the message fails to send.

retry

Boolean

No

Indicates whether the wallet server allows you to retry when the message fails to send. Therefore, this field is required only when the value of the success field is false.

The value of the retry field is: 

• true : the wallet server allows to retry under specific circumstances, for example, when there are system exceptions.
• false : the wallet server does not allow to retry. For example, when the fatigue degree in the wallet server is reached, retry is not allowed.

Property

Data type

Required

Description

templateParameters

Map<String,String>

No

A string-to-string mapping. The data structure is in JSON format: 

"templateParameters": {"key": "value"}  

, where: 

• key : represents the placeholder that is designed in the selected message template.
• value : is used to replace the value of the  key parameter in the message template.

language

String

No

RFC 1766, such as zh-CN, en-US.

Key

Description

SMS

SMS. 

PUSH

PUSH.

INBOX

INBOX.

Key

Description

IOS

iOS.

ANDROID

Android.