用户使用NFC能力后推送消息

功能介绍

用户使用华为钱包NFC能力后，开发者可能使用此接口向用户推送消息。

场景描述

开发者开启了相关卡券的NFC能力且在AGC网站上注册了NFC回调地址。当用户使用华为钱包NFC能力后，钱包服务器调用NFC卡券事件回调通知接口通知开发者服务器，该请求包含了一个“noticeToken”参数。开发者可以使用此“noticeToken”参数调用此接口，向用户推送消息。比如用户刷了小区门禁卡之后，开发者向用户推送有待收快递的信息。

使用约束

使用此接口的开发者应首先实现卡券NFC能力，且在AGC网站上注册了NFC回调地址。在接收到NFC卡券事件回调通知接口发送的请求后再调用此接口。

接口原型

承载协议	HTTPS POST
接口方向	开发者服务器 ->华为钱包服务器
接口URL	{url}/hmspass/v1/callbackevent/pushmsg {url}变量需要开发者根据服务器所属区域自行选择，请参见钱包服务器地址。
数据格式	请求消息：Content-Type: application/json 响应消息：Content-Type: application/json

请求参数

Request Header：

参数	是否必选	参数类型	描述
Authorization	是	String	鉴权码。获取方式详见基于OAuth 2.0开放鉴权，请使用“客户端模式”。“client_id”和“client_secret”即为开发者在华为AGC网站上创建应用后获取的“App ID”和“App key”。将获取到的“access_token”的值拼接在字符串“Bearer”之后，以空格符相隔，组成“Authorization”参数的值。
Content-Type	是	String	固定值：“application/json;charset=utf-8”。
Accept	是	String	固定值：“application/json;charset=utf-8”。

Request Body：

参数	是否必选	参数类型	描述
noticeToken	是	String(64)	NFC事件对应的标识。由NFC卡券事件回调通知接口提供。
message	是	String(256)	向用户推送的消息。

请求示例

POST /hmspass/v1/callbackevent/pushmsg HTTP/1.1
Content-Type: application/json;charset=utf-8
Authorization: Bearer ***
Accept: application/json;charset=utf-8
Host: wallet-passentrust-drcn.cloud.huawei.com.cn
{
  "noticeToken": "3edc0efa7d2e186652d38b19f643dc0e57e7f4e1eb43d889b5678f810f64fd18",
  "message": "You have a message."
}

响应参数

错误码为200时：

参数	参数类型	描述
returnCode	String	响应码，“0”表示成功。
returnDesc	String	响应描述，成为是为“success”。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json
{
  "returnCode": "0",
  "returnDesc": "success"
}

目录