删除令牌
删除已在服务器上注册的用户推送令牌。
URL 确认
此 API 使用 service-api.playnanoo.com 域名。
API 信息
- URL:
https://service-api.playnanoo.com/push/v20220701/remove - Method:
PUT - 需要认证: 是
DeviceInfo 继承
此 API 的 Req 类继承自 DeviceInfo。DeviceInfo 的所有属性会自动包含。
请求参数
此 API 没有额外的请求参数。
响应数据
Res 类
| 字段 | 类型 | 说明 |
|---|---|---|
| Status | string | 处理结果状态 |
Unity C# 实现
BaseResponse 类
所有 API 响应的基类。
public class BaseResponse
{
public string ErrorCode;
public string Message;
public string WithdrawalKey;
public string BlockKey;
}
字段说明:
ErrorCode:错误代码Message:错误信息WithdrawalKey:账号处于注销等待状态时,用于恢复的密钥(仅注销等待中的账号提供)BlockKey:账号被封禁时提供的密钥(仅被封禁的账号提供)
推送令牌删除类
using System;
using System.Collections;
using UnityEngine.Networking;
public class PushRemove
{
static string url = "https://service-api.playnanoo.com/push/v20220701/remove";
[Serializable]
public class Req : DeviceInfo
{
public IEnumerator Send(
Action<Res> onSuccess,
Action<BaseResponse> onError)
{
// PUT 방식 호출
yield return HttpClient.Send<Req, Res>(
UnityWebRequest.kHttpVerbPUT,
url,
requireToken: true,
body: this,
onSuccess: onSuccess,
onError: onError
);
}
}
[Serializable]
public class Res : BaseResponse
{
public string Status;
}
}
使用示例
using PlayNANOO;
public class PlayNANOOExample : MonoBehaviour
{
void Start()
{
RemovePushToken();
}
void RemovePushToken()
{
PushRemove.Req req = new PushRemove.Req();
StartCoroutine(req.Send(
onSuccess: res =>
{
Debug.Log($"푸시 토큰 삭제 성공: {res.Status}");
},
onError: (error) =>
{
Debug.LogError($"푸시 토큰 삭제 실패: [{error.ErrorCode}] [{error.Message}]");
}
));
}
}
令牌删除时机
当用户登出或完全停用推送通知时,可以调用此 API 从服务器中删除推送令牌。
需要重新注册
删除令牌后,如需再次接收推送通知,必须通过保存令牌 API 重新注册。
使用场景
- 用户登出时
- 应用卸载前的清理工作
- 完全停用推送通知时