# 用户群标签
# 1、接口地址
- 设置用户群签:https://xxxxxxx/api/dyminigame/setusergrouptag
- 查询用户群签:https://xxxxxxx/api/dyminigame/getusergrouptag
# 2、使用场景
WARNING
- 前提:抖音群聊,后台新增标签配置
- 群标签能力是抖音小游戏继粉丝群、官方群后提供的第三大群聊能力。接入此能力后,可以满足群粉丝在群内聊天时,在群昵称后自动携带由厂商配置的称号标签,且点击标签即可查询获得方式以及启动游戏。
- 接入收益:
- 1.丰富群聊话题,增加粉丝聊天积极性,提高群的整体活跃度
- 2.增加群内复访游戏入口,提高用户留存
- 参考群标签能力接入方案 (opens new window)
# 3、接口说明
# 4.1、请求方式
接口地址:
方式:POST
接入方式: 直接接入
请求参数: headers头 Body raw(JSON)
| 参数类型 | 字段名 | 值类型 | 必填 | 说明 |
|---|---|---|---|---|
| Body | appId | int | 是 | 产品ID |
| Body | accountId | long | 否 | 账号ID |
| Body | timestamp | long | 否 | 当前时间戳,秒,前后2小时有效 |
| Body | sign | string | 是 | 接口加密签名md5("accountId=" + accountId + "&appId=" + appId + "×tamp=" + timestamp + appkey) |
| Body | mainChannel | int | 是 | sdk配置的主渠道ID |
| Body | secondChannel | int | 是 | sdk配置的次渠道ID |
| Body | status | int | 是 | 用户铭牌标签状态: 1-已佩戴 3-已删除 |
| Body | tagId | string | 是 | 铭牌id,在抖音开发者后台配置,见文档 群标签能力接入方案 (opens new window) |
# 4.2、接口响应说明
- 请求示例
{"appId":1315001528,"accountId":2118621534,"timestamp":1786953600,"sign":"af4e42f412cd289fa2a7879f73b81daf","mainChannel":100774,"secondChannel":100775,"status":1,"tagId":"4155970560002"}
响应结果JSON格式
{ "resultCode": 10000, "datum": null, "resultInfo": "", "rid": "sidysgtag.884650e99dec419aaf95a200a1cc2932" }返回说明:
| 参数类型 | 字段名 | 必填 | 值类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| result | resultCode | int | 是 | 响应值 | 10000成功,其它失败 |
| result | resultInfo | 是 | string | 提示信息 |
# 5、查询用户群标签
:::
# 5.1、请求方式
方式:POST
接入方式: 直接接入
请求参数: headers头 Body raw(JSON)
| 参数类型 | 字段名 | 值类型 | 必填 | 说明 |
|---|---|---|---|---|
| Body | appId | int | 是 | 产品ID |
| Body | accountId | long | 否 | 账号ID |
| Body | timestamp | long | 否 | 当前时间戳,秒,前后2小时有效 |
| Body | sign | string | 是 | 接口加密签名md5("accountId=" + accountId + "&appId=" + appId + "×tamp=" + timestamp + appkey) |
| Body | mainChannel | int | 是 | sdk配置的主渠道ID |
| Body | secondChannel | int | 是 | sdk配置的次渠道ID |
# 5.2、接口响应说明
- 请求示例
{"appId":1315001528,"accountId":2118621534,"timestamp":1786953600,"sign":"af4e42f412cd289fa2a7879f73b81daf","mainChannel":100774,"secondChannel":100775}
响应结果JSON格式
{ "resultCode": 10000, "datum": { "user_group_tag_list": [ { "status": 1, "tag_id": "547998720770", "template_id": "546358272258" } ] }, "resultInfo": "", "rid": "sidysgtag.bba3f6cf0c3d45829ea4631e9c62ebd8" }返回说明:
| 参数类型 | 字段名 | 必填 | 值类型 | 说明 | 备注 |
|---|---|---|---|---|---|
| result | resultCode | int | 是 | 响应值 | 10000成功,其它失败 |
| result | resultInfo | 是 | string | 提示信息 | |
| result | datum | 是 | object | 消息实体 | |
| result | datum->user_group_tag_list | 是 | list | 标签数组 | |
| result | datum->user_group_tag_list->status | 是 | int | 状态: 1-已佩戴 3-已删除 | |
| result | datum->user_group_tag_list->tag_id | 是 | string | 标签ID | |
| result | datum->user_group_tag_list->template_id | 是 | string |