alipay.intl.user.inform.delegateSendNotification
Overview
URL: alipay.intl.user.inform.delegateSendNotification
This API is used by the merchant delegated to Alipay to send notifications to multiple users associated with the open IDs.
Request
Request parameters
Header
No | Name | Description | Type | Length | Required | Remarks | Sample |
1 | version | API version | string | 8 | ME | As per the respective API reference. | 2.0.0 |
2 | function | API interface | string | 128 | ME | According to specifications defined by each business domain. | alipay.intl.function |
3 | clientId | Client ID | string | 32 | ME | Provided by Alipay, used to identify partner and application system. | 211020000000000000044 |
4 | reqTime | Request time | datetime | / | M | DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6 | 2001-07-04T12:08:56+05:30 |
5 | reqMsgId | Request message ID | string | 64 | ME | Each request will be assigned with a unique ID (uuid). The reqMsgId identifies a unique system request, it is not used to identify a unique business request. | 1234567asdfasdf1123fda |
6 | reserve | Reserved for future implementation | string | 256 | O | Key/Value | {} |
Body
No | Name | Description | Type | Length | Required | Remarks | Sample |
1 | merchantId | Merchant ID | string | 64 | M | 2160400000000177 | |
2 | notificationInfos | Notification information list, one notification per user. | list<[NotificationInfo](data_structure/04. User Domain Structure.htm#NotificationInfo)> | / | M | This list's maximum size is 100, that is, this list can not have more than 100 elements. Every element's maximum length is 300, that is, every element can not have more than 300 characters. | [ { "openId": "1234567890abcdefghijk1234567890aa", "templateCode": "ALIPAYHK_MOBILE_SINGLE_MERCHANT_BILL", "templateValue": "{"merchantName":"alipay", "redirectUrl":"http://www.alipay.com/index.htm"}" }, { "openId": "1234567890abcdefghijk1234567890ab", "templateCode":"ALIPAYHK_MOBILE_MULTIPLE_MERCHANTS_BILL", "templateValue": "{"billCount":"5", "redirectUrl":"http://www.alipay.com/index.htm"}" }] |
Sample
{
"request":{
"head":{
"version":"2.0.0",
"function":"alipay.intl.user.inform.delegateSendNotification",
"clientId":"211020000000000000044",
"reqTime":"2001-07-04T12:08:56+05:30",
"reqMsgId":"1234567asdfasdf1123fda",
"reserve":"{}"
},
"body":{
"merchantId":"2160400000000177",
"notificationInfos":[
{
"openId":"1234567890abcdefghijk1234567890ab",
"templateCode":"ALIPAYHK_MOBILE_ SINGLE_MERCHANT_BILL",
"templateValue":"{\"merchantName\":\"alipay\", \"redirectUrl\":\"http://www.alipay.com/index.htm\"}"
}
]
}
},
"signature":"signature string"
}Response
Response parameters
Header
No | Name | Description | Type | Length | Required | Remarks | Sample |
1 | version | API version | string | 8 | ME | As per the respective API reference. | 2.0.0 |
2 | function | API interface | string | 128 | ME | According to specifications defined by each business domain. | alipay.intl.function |
3 | clientId | Client ID | string | 32 | ME | Provided by Alipay, used to identify partner and application system. | 211020000000000000044 |
4 | respTime | Response time | datetime | / | M | DateTime with timezone, which follows the ISO-8601 standard. Refer to: RFC 3339 Section 5.6 | 2001-07-04T12:08:56+05:30 |
5 | reqMsgId | Request message ID | string | 64 | ME | Each request will be assigned with a unique ID (uuid). | 1234567asdfasdf1123fda |
6 | reserve | Reserved for future implementation | string | 256 | O | Key/Value | {} |
Body
No | Name | Description | Type | Length | Required | Sample |
1 | resultInfo | Result information | [ResultInfo](data_structure/00. Global Common Structure.htm#ResultInfo) | / | M | {"resultStatus": "S","resultCodeId": "00000000","resultCode":"SUCCESS","resultMsg": ""} |
Sample
{
"response":{
"head":{
"version":"2.0.0",
"function":"alipay.intl.user.inform.delegateSendNotification",
"clientId":"211020000000000000044",
"respTime":"2001-07-04T12:08:56+05:30",
"reqMsgId":"1234567asdfasdf1123fda",
"reserve":"{}"
},
"body":{
"resultInfo":{
"resultStatus":"S",
"resultCodeId":"00000000",
"resultCode":"SUCCESS",
"resultMsg":"success"
}
}
},
"signature":"signature string"
}Result codes
Basic result codes
The following global result codes might be returned for all APIs:
No | ResultCodeId | ResultCode | ResultStatus | Remarks |
1 | 00000000 | SUCCESS | S | Success |
2 | 00000019 | PROCESS_FAIL | F | General business failure. No retry. |
3 | 00000901 | UNKNOWN_EXCEPTION | U | API failed due to unknown reasons. |
4 | 00000004 | PARAM_ILLEGAL | F | Illegal parameters. For example, non-numeric input, invalid date. |
5 | 00000007 | INVALID_SIGNATURE | F | The signature is invalid. |
6 | 00000008 | KEY_NO_FOUND | F | The key is not found. |
7 | 00000013 | NO_INTERFACE_DEF | F | API is not defined. |
8 | 00000014 | API_IS_INVALID | F | API is invalid or not active. |
9 | 00000016 | OAUTH_FAILED | F | oAuth authentication failed |
10 | 00000021 | ACCESS_DENIED | F | Access denied |
11 | 12014152 | CLIENT_FORBIDDEN_ACCESS_API | F | The client is not authorized to use this API. |
12 | 12014155 | UNKNOWN_CLIENT | F | Unknown client |
13 | 12014156 | INVALID_CLIENT_STATUS | F | Invalid client status |
14 | 00000024 | REQUEST_TRAFFIC_EXCEED_LIMIT | F | Request traffic exceeds the limit. |