跳转至

退订已开通服务的订单

1. 接口描述

接口请求路径:POST /prod-api/acdn/volc/hostAcceleratePackRest/unsubscribeHostAcceleratePackOrder

unsubscribeHostAcceleratePackOrder 用于退订已开通服务的主播加速服务订单。

注意事项:单用户请求频率限制为 10 次/秒。

Token 获取方式见 密钥鉴权

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
tdPackOrders [TDPackOrder] 待退订的订单列表

3. 输出参数

参数名称 类型 描述
code Integer 状态码。示例值:200
msg String 提示信息。示例值:操作成功
data Array 退订结果列表
data[].orderId String 订单 ID。示例值:17872269834801546
data[].uid String 抖音 uid。示例值:75114807678
data[].endTime String 服务结束时间。示例值:2024-01-31
data[].status Integer 退订订单状态。取值:1(退订成功)、2(OrderId 和 Uid 不匹配)、3(订单不存在)、4(订单不在生效时间范围,无需退订)、5(内部服务错误)。示例值:1

4. 示例

示例1 退订已开通服务的订单

输入示例

{
  "tdPackOrders": [
    {
      "uid": "7189307678",
      "orderId": "17848908678801546"
    }
  ]
}

代码调用

请将 {登录域名}token 替换为实际值。

curl -X POST 'https://{登录域名}/prod-api/acdn/volc/hostAcceleratePackRest/unsubscribeHostAcceleratePackOrder' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.xxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
  "tdPackOrders": [
    {
      "uid": "7189307678",
      "orderId": "17848908678801546"
    }
  ]
}'
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class UnsubscribeHostAcceleratePackOrderTest {

    public static void main(String[] args) throws Exception {
        String url = "https://{登录域名}/prod-api/acdn/volc/hostAcceleratePackRest/unsubscribeHostAcceleratePackOrder";
        String token = "eyJhbGciOiJIUzUxMiJ9.xxxxxx";

        String requestBody = "{"
                + "\"tdPackOrders\":[{"
                + "\"uid\":\"7189307678\","
                + "\"orderId\":\"17848908678801546\""
                + "}]"
                + "}";

        try (CloseableHttpClient httpClient = HttpClients.createDefault()) {
            HttpPost httpPost = new HttpPost(url);
            httpPost.setHeader("Authorization", "Bearer " + token);
            httpPost.setEntity(new StringEntity(requestBody, ContentType.APPLICATION_JSON));

            try (CloseableHttpResponse response = httpClient.execute(httpPost)) {
                int statusCode = response.getStatusLine().getStatusCode();
                String body = EntityUtils.toString(response.getEntity(), "UTF-8");
                System.out.println("Status Code: " + statusCode);
                System.out.println("Body: " + body);
            }
        }
    }
}
package main

import (
    "bytes"
    "fmt"
    "io"
    "net/http"
)

func main() {
    url := "https://{登录域名}/prod-api/acdn/volc/hostAcceleratePackRest/unsubscribeHostAcceleratePackOrder"
    token := "eyJhbGciOiJIUzUxMiJ9.xxxxxx"

    requestBody := []byte(`{
  "tdPackOrders": [
    {
      "uid": "7189307678",
      "orderId": "17848908678801546"
    }
  ]
}`)

    req, err := http.NewRequest(http.MethodPost, url, bytes.NewReader(requestBody))
    if err != nil {
        panic(err)
    }
    req.Header.Set("Authorization", "Bearer "+token)
    req.Header.Set("Content-Type", "application/json")

    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, err := io.ReadAll(resp.Body)
    if err != nil {
        panic(err)
    }
    fmt.Println("Status Code:", resp.StatusCode)
    fmt.Println("Body:", string(body))
}

输出示例

{
  "msg": "操作成功",
  "code": 200,
  "data": [
    {
      "status": 1,
      "endTime": "2024-01-31",
      "uid": "75114807678",
      "orderId": "17872269834801546"
    }
  ]
}

5. 错误码

HTTP 状态码 / 业务提示 描述
200 成功
401 未鉴权或 Token 无效
403 无权限
请输入参数 请求体为空
请输入需要退订的订单 tdPackOrders 为空
发起失败,存在无效的orderId 存在不属于当前账号或无效的订单 ID

6. 数据模型

TDPackOrder

待退订的订单项。

参数名称 必选 类型 描述
orderId String 订单 ID。示例值:17848908678801546
uid String 抖音 uid。示例值:7189307678