更改租赁状态

setRentStatus 方法用于通过 SMS.online API 更改租用虚拟号码的当前状态。该方法可以自动化管理租赁状态,包括结束使用号码、延长租期或释放号码。

该方法适用于需要实时控制租用号码状态的系统。通过它可以指示租赁结束、延长或其他状态变更,以保持信息的准确性。

成功的请求将返回一个对象,确认租赁状态的更改,包括更新后的租赁参数。该方法在需要快速更新租用号码使用信息的服务中尤其有用。

请求示例:

输入数据

参数必填备注描述
请参见个人资料中的 API 密钥 设置API 密钥提供对付费服务的访问
setRentStatus方法名称
数值在请求号码时获得的激活 ID
数值租赁状态

状态可以取以下值:

1 - 结束号码使用

2 - 取消购买

服务器响应

JSON
{ 
  "status": "success"
}

代码示例

const api_key = "API_KEY"; # 将 'API_KEY' 替换为您的实际 API 密钥。
const id = 1; # 插入在请求号码时获得的激活 ID
const status = 1; # 插入上表中的新状态
try {
const response = await fetch(`https://api.sms.onlinestubs/handler_api.php?api_key=${api_key}&action=setRentStatus&id=${id}&status=${status}`);
# 对指定的 URL 执行 GET 请求
const data = await response.json();
# 输出服务器响应的内容
console.log(data);
} catch (err) {
# 如果发生错误,输出错误消息
console.error(err);
}

可能的错误

参数描述
不正确的操作
无效的 API 密钥
请求错误
账户被禁用的时间
账户未激活
未指定租赁 ID
号码不是您租用的(无效的租赁 ID)
缺少或错误的状态
无法取消租赁(超过 20 分钟)
租赁已结束
租赁已取消