本文介绍 Android SDK 4.x 将当前设备与电话号码绑定或解绑的接口。
适用于移动推送 Android SDK 4.x,本文接口和示例以已发布的 4.0.0 版本为基线。使用 3.x 的应用请参见对应的 3.x API 文档。
适用场景
在推送与短信联动场景中,客户端通过以下接口关联设备和电话号码。绑定成功表示关联已建立;短信补发条件和时间由服务端推送参数决定。
调用前,请完成 PushServiceFactory.init 和推送注册,并确认 register 的 onSuccess 已返回。通过 PushServiceFactory.getCloudPushService() 获取 CloudPushService。示例使用非空 CommonCallback;失败时查看 onFailed 的 errorCode 和 errorMessage。
绑定电话号码(bindPhoneNumber)
接口定义
void bindPhoneNumber(String phoneNumber, CommonCallback callback);
所属类
CloudPushService
参数说明
|
参数 |
类型 |
是否必填 |
说明 |
|
phoneNumber |
String |
是 |
待绑定的有效手机号,不能为 null 或空字符串。 |
|
callback |
CommonCallback |
否 |
操作结果回调。可为 null;建议传入非空回调,以获取成功结果或失败原因。 |
返回值与回调
返回值为 void。手机号绑定成功时触发 onSuccess(String response);操作失败时触发 onFailed(String errorCode, String errorMessage),分别返回错误码和错误信息。
代码示例
public void bindDevicePhoneNumber(String phoneNumber) {
CloudPushService pushService = PushServiceFactory.getCloudPushService();
pushService.bindPhoneNumber(phoneNumber, new CommonCallback() {
@Override
public void onSuccess(String response) {
Log.i("PushDemo", "bindPhoneNumber success");
}
@Override
public void onFailed(String errorCode, String errorMessage) {
Log.e("PushDemo", "bindPhoneNumber failed: " + errorCode + ", " + errorMessage);
}
});
}fun bindDevicePhoneNumber(phoneNumber: String) {
val pushService = PushServiceFactory.getCloudPushService()
pushService.bindPhoneNumber(phoneNumber, object : CommonCallback {
override fun onSuccess(response: String?) {
Log.i("PushDemo", "bindPhoneNumber success")
}
override fun onFailed(errorCode: String?, errorMessage: String?) {
Log.e("PushDemo", "bindPhoneNumber failed: $errorCode, $errorMessage")
}
})
}解绑电话号码(unbindPhoneNumber)
解除当前设备与手机号的绑定关系。
接口定义
void unbindPhoneNumber(CommonCallback callback);
所属类
CloudPushService
参数说明
|
参数 |
类型 |
是否必填 |
说明 |
|
callback |
CommonCallback |
否 |
操作结果回调。可为 null;建议传入非空回调,以获取成功结果或失败原因。 |
返回值与回调
返回值为 void。手机号解绑成功时触发 onSuccess(String response);操作失败时触发 onFailed(String errorCode, String errorMessage),分别返回错误码和错误信息。
代码示例
CloudPushService pushService = PushServiceFactory.getCloudPushService();
pushService.unbindPhoneNumber(new CommonCallback() {
@Override
public void onSuccess(String response) {
Log.i("PushDemo", "unbindPhoneNumber success");
}
@Override
public void onFailed(String errorCode, String errorMessage) {
Log.e("PushDemo", "unbindPhoneNumber failed: " + errorCode + ", " + errorMessage);
}
});val pushService = PushServiceFactory.getCloudPushService()
pushService.unbindPhoneNumber(object : CommonCallback {
override fun onSuccess(response: String?) {
Log.i("PushDemo", "unbindPhoneNumber success")
}
override fun onFailed(errorCode: String?, errorMessage: String?) {
Log.e("PushDemo", "unbindPhoneNumber failed: $errorCode, $errorMessage")
}
})验证
确认绑定接口成功后,再结合服务端短信联动配置验证完整流程。日志和示例截图中的电话号码请脱敏。
相关文档
接入流程请参见Android SDK接入(4.x)。
使用 3.x 的应用请参见短信通知接口(3.x)。