调用 UpdateHostAccount 接口,在当前账号下新增主播账号或更新已有主播账号的信息。
Id(主播账号 ID)或传入 Id 且参数取值为 0 ,即可新增主播账号。Id 参数值,即可更新该账号信息。您可以通过 ListHostAccounts 接口查询 ID。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UpdateHostAccount | 接口名称。当前 API 的名称为 UpdateHostAccount。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| HostAccount | Object of HostAccount | 否 | - | 主播账号信息列表。 |
| GetFollowDataUrl | String | 否 | https://example.com | 查询接口 URL。您需要自行开发该接口,用于查询用户是否关注主播。详见关注主播接口。 |
| UpdateFollowDataUrl | String | 否 | https://example.com | 更新接口 URL。您需要自行开发该接口,用于更新用户关注主播状态。详见关注主播接口。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Id | Long | 否 |
| 主播账号 ID。
|
| Name | String | 是 | 主播名称 | 主播账号名称。最多支持输入 20 个字符。 |
| AvatarUrl | String | 是 | https://p.example.org/6ed59yyum2-z75.png | 主播账号头像地址。需要包含 https 协议头。 |
IsFollowEnable | Integer | 否 |
| 是否开启观众关注主播功能。支持以下取值,默认取值为
|
| HomeUrl | String | 否 | https://example.com | 主播账号的主页链接。观众在观看页点击主播头像或名称时,即可跳转至该链接。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| HostAccountId | Long | 114333 | 新增或更新的主播账号 ID。 |
POST https://livesaas.volcengineapi.com/?Action=UpdateHostAccount&Version=2023-08-01 { "HostAccount": { "Id": 114333, "Name": "主播名称", "AvatarUrl": "https://p.example.org/6ed59yyum2-z75.png", "IsFollowEnable": 1, "HomeUrl": "https://example.com" }, "GetFollowDataUrl": "https://example.com", "UpdateFollowDataUrl": "https://example.com" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "UpdateHostAccount", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1715326286 }, "Result": { "HostAccountId": 114333 } }