> For the complete documentation index, see [llms.txt](https://polyv.gitbook.io/document/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://polyv.gitbook.io/document/docs/live/api/v-4/user/update_global_footer.md).

# 修改页脚设置

### 接口描述

```
1、修改全局页脚设置
2、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/live/v4/user/global-setting/footer/update
```

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/live/v4/user/global-setting/footer/update/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/limit/README.md)

2、showFooterEnabled、footerText、footTextLinkProtocol、footTextLinkUrl 不传值默认不修改

### 请求参数描述

| 参数名       | 必选   | 类型     | 说明                                                                                                                                                                                                        |
| --------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| appId     | true | String | 账号appId【详见[获取密钥](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/getSecretKey/README.md)】                                                                                        |
| timestamp | true | Long   | 当前13位毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign      | true | String | 签名，为32位大写的MD5值,`生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/buildSign/README.md)】 |

### 请求体参数描述

| 参数名                  | 必选    | 类型     | 说明                                      |
| -------------------- | ----- | ------ | --------------------------------------- |
| showFooterEnabled    | false | String | <p>是否开启页脚<br>Y：开启<br>N：关闭</p>           |
| footerText           | false | String | 页脚文案，最大长度12                             |
| footTextLinkProtocol | false | String | <p>页脚链接协议头<br>http\:// 或者 https\://</p> |
| footTextLinkUrl      | false | String | 页脚链接地址，最大长度50，不用带协议，`例如：www.polyv.net`  |

### 示例

```requestUrl
http://api.polyv.net/live/v4/user/global-setting/footer/update?appId=frlr1zazn3&sign=488A9283731A8D3552593050E0081206&timestamp=1672884857202
```

请求体参数：

```requestUrl
{
    "footerText": "保利威提供技术支持",
    "footTextLinkUrl": "www.polyv.net",
    "showFooterEnabled": "Y",
    "footTextLinkProtocol": "https://"
}
```

### 响应参数描述

| 参数名       | 类型      | 说明                                       |
| --------- | ------- | ---------------------------------------- |
| code      | Integer | 状态码，与 http 状态码相同，用于确定基本的响应状态             |
| status    | String  | 响应结果，由业务决定，成功返回success，失败返回error         |
| success   | Boolean | 是否成功响应                                   |
| requestId | String  | 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩 |
| error     | Object  | 状态码非200时的错误信息【详见[Error字段描述](#error参数描述)】 |
| data      | Boolean | 请求成功返回true，请求失败返回空                       |

### Error参数描述

| 参数名  | 类型      | 说明                   |
| ---- | ------- | -------------------- |
| code | Integer | 错误代码，用于确定具体的错误原因     |
| desc | String  | 错误描述，与 error.code 对应 |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 LiveSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[直播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/live/java/README.md)完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
/**
 * 修改页脚设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateGlobalFooterSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/global-setting/footer/update";
    String showFooterEnabled = "Y";
    String footerText = "保利威提供技术支持";
    String footTextLinkProtocol = "https://";
    String footTextLinkUrl = "www.polyv.net";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("showFooterEnabled", showFooterEnabled);
    jsonMap.put("footerText", footerText);
    jsonMap.put("footTextLinkProtocol", footTextLinkProtocol);
    jsonMap.put("footTextLinkUrl", footTextLinkUrl);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改页脚设置成功：{}", response);
    //do somethings
    
}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/live/api/errorInfo/README.md)

成功示例

```json
{
    "code": 200,
    "status": "success",
    "requestId": "f14199d88cde4db4920d1fc1deb5d2d2.64.16728213873928631",
    "data": true,
    "success": true
}
```

异常示例

```json
{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}
```