套餐升级/降级 - 探鸽开放平台API文档

本质是修改套餐能力，如一下场景：
已购买套餐A（事件录像保存3天）
想升级到套餐B（事件录像保存7天）
那可传参为：{"order_id":<套餐A的订单ID>,"service_id":<B套餐ID>}

请求参数

Header 参数

X-Tg-App-Id

string

必需

开发者帐号的APPID

默认值:

Accept-Language

string

必需

请求端的本地语言（zh-cn, zh-tw, en-us, ja, ko, vi, es, pt, ru, tr, de, it, fr, pl, th, ar）

默认值:

Authorization

string

必需

服务端接口时传入签名计算后的字符串。客户端APP传入用户登陆态数据access_token。两者不要混用。

默认值:

X-Tg-Signed-Headers

string

必需

参与计算签名的header字段。POST等请求传入content-length;content-type;x-tg-app-id;x-tg-date，GET请求传入x-tg-app-id;x-tg-date

默认值:

x-tg-app-id;x-tg-date

示例值:

content-length;content-type;x-tg-app-id;x-tg-date

X-Tg-Date

string

必需

当前请求的UTC+0时间（注意时区，不是本地时区）

默认值:

20060102T150405Z

X-Tg-Content-Sha256

string

必需

将BODY数据进行SHA256计算后的值

X-Tg-Algorithm

string

必需

目前服务端接口使用的签名算法的版本号和哈希算法

默认值:

TGV1-HMAC-SHA256

Content-Type

string

必需

默认值:

application/json

Content-Length

string

必需

Body的字符串长度

Body 参数application/json

order_id

integer

套餐订单ID

必需

设备的套餐列表接口，返回的order_id字段

service_id

integer

套餐ID

必需

开发者套餐列表接口，返回的service_id字段

示例

{
  "order_id": 0,
  "service_id": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

非200表示出错

msg

string

错误描述

必需

data

object

必需

integer

服务ID

必需

order_id

integer

订单ID

必需

device_id

string

设备ID

必需

iccid

string

物联网卡号

必需

product_id

integer

套餐产品ID

必需

service_id

integer

套餐ID

必需

ability

object

服务能力

必需

level

integer

服务级别

必需

is_free

integer

是否免费的服务

必需

0否、1是

contract_status

integer

签约状态

必需

0非签约、1签约下月为申请扣费、2签约下月申请扣费成功、3签约下月申请扣费失败、4签约下月申请扣费成功、5签约已退订

status

integer

套餐状态

必需

0正常、1已冻结

frozen_time

integer

冻结时间戳

必需

1682666553

start_time

integer

服务开始时间戳

必需

1682666553

end_time

integer

服务结束时间戳

必需

1682666553

示例

{
  "code": 200,
  "msg": "ok",
  "data": {
    "id": 70,
    "order_id": 70,
    "device_id": "1702D8OBYWWQ",
    "iccid": "89861122241045896497",
    "product_id": 70,
    "service_id": 70,
    "ability": {
      "storage": {
        "recording_mode": "INCIDENT",
        "recording_content": [
          "IMAGE"
        ],
        "recording_ahead": 5,
        "recording_duration": 30,
        "recording_image_max": 5,
        "recording_image_span": 3,
        "save_days": 30
      },
      "ai": {
        "algorithm": [
          "body",
          "pet"
        ]
      },
      "mobile_data": {
        "traffic_limit": 500,
        "limit_mode": "month"
      },
      "smart_box": {
        "supported_smart_box": [
          "echo-show"
        ]
      }
    },
    "level": 2,
    "is_free": 0,
    "contract_status": 0,
    "status": 0,
    "frozen_time": 1682666553,
    "start_time": 1682666553,
    "end_time": 1682666553
  }
}

🟠400错误

🟠401请登录

🟠403禁止访问

🟠404资源不存在

🔴500服务器内部错误