设置进群问候语&群公告

使用限制

•

需要用户授权，授权用户需为粉丝群群主身份

•

仅支持粉丝群类型的群聊

接口说明

本接口可用于设置进群问候语，群公告配置。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/im/group/setting/set/
HTTP Method	POST
Scope	im.group_fans.create_list

请求头

名称	字段类型	是否必填	示例	描述
access-token	String	是	bus_act.1d1021d2aee3d41fee2d2adfwdf56badMFZnrhFhfWotu3Ecuiuka27L56lr	通过 BusinessToken 进行调用
content-type	String	是	application/json	固定值"application/json"

请求参数

Query

名称	字段类型	是否必填	示例	描述
open_id	String	是	ba253642-0590-40bc-9bdf-9a1334b94059	可以通过 code2Session 接口获取，用户唯一标志

Body

名称			字段类型	是否必填	示例	描述
group_id			String	是		粉丝群 ID
group_setting_type			Enum	是		群管理配置类型
	WELCOME=1					欢迎语
	NOTICE=2					群公告
msg_list			List	是		欢迎语支持 •同时设置文本 + 小程序引导卡片 •同时设置文本 + 小程序券群公告只支持设置文本
msg_type	msg_type		Enum	是		回复内容的类型
		TEXT=1
		APPLETCARD=10
		APPLET_COUPON=11
	applet_coupon		Struct	否		小程序券
		activity_id	Int64	否		activity_id 获取方式详见查询授权用户发放的活动信息
		coupon_meta_id	Int64	否		coupon_id 获取方式详见查询券模板
	text		Struct	否		文字内容
		text	String	否		文字内容，长度需小于 150
	applet_card
		card_template_id	String	否		卡片模板 ID
		path	String	否	api/apiPage/apiPage	通过URL Link进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。
		query	String	否	{\"key1\":\"val1\",\"key2\":\"val2\"}	通过URL Link进入小程序时的 query（json形式），若无请填{}。最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`{}!#$&'()*+,/:;=?@-._~%``。
		app_id	String	否		小程序

请求示例

curl -X  POST 'https://open.douyin.com//im/group/setting/set/?open_id=_000xzRQpcoxD3BxBa8gh_pSqhCts9e7W5Of' \
 
-H 'Content-Type:application/json' \
-H 'access-token:act.3.twcMj968gNlk10bQxejCFptAgy7xz14cpuNplMTCt4PKnO8_K2pzgTfWh6PuCI9iBuUBrMxmc357OI_9zz-BP2ypsGC1giKiQEyzWiRSc48Vk_mh3Q_yJJjKInJslCnbzUPBP7k3LHM-mw-4M2yDwbQNROIvpQOs8o_DK96ZnEUj9xfXqQk1oZy_I48=' \
\
 --data '
{
    "group_setting_type":1,
    "group_id":"@4F8C16DLBMpoayH0MI44GaX+1WSGOvqKMpZ2rgigLVAab/b033bhf2Iujgn96zUFzrEMFkG/vUKhYHQ90PrjsQ==",
 \
   "msg_list":[
        {
            "msg_type":1,
            "text":{
       \
         "text":"66666"
            }
        },
        {
            "msg_type":10,
 \
           "applet_card":{
                "card_template_id":"@4F8C16DLB+1WSGO/yAA61JkTKeF2ltKgvvhATKtvrScVZhhxZ/",
 \
               "schema":"https://z.douyin.com/lktwYRo",
                "app_id":"ttfa398c06e94401"
 \
           }
        }
    ]
}' \

响应参数

Body

名称	字段类型	是否必填	示例	描述
err_msg	String	是
err_no	Int32	是
log_id	String	是

响应示例

正常示例

{
  "err_msg": "",
  "err_no": 0,
  "log_id": "02169835144317200000000000000000000ffff0a707803a3982e"
}

异常示例

{
  "err_no": 28001007,
  "err_msg": "invalid text, contains url pattern",
  "log_id": "202405202301116F2D6D2E84AC0F262D2C"
}

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常

设置进群问候语&群公告在线调试

​使用限制​

​接口说明​

​基本信息​

​请求头​

​请求参数​

​Query​

​Body​

​请求示例​

​响应参数​

​Body​

​响应示例​

​正常示例​

​异常示例​

​错误码​

设置进群问候语&群公告

使用限制

接口说明

基本信息

请求头

请求参数

Query

Body

请求示例

响应参数

Body

响应示例

正常示例

异常示例

错误码