poyee-im/api.md

IM接口文档

目录

• 商家禁言
• 校验用户是否禁言

商家禁言

接口描述：新商家禁言接口

• 请求方法：PUT
• Content-Type：application/json;
• 请求URL：/api/livechat/forbidden

请求参数

参数名称	参数	类型	必填	描述
sender	avatar	string	否	头像
	nickname	string	否	昵称
	id	int	是	用户编号
type		int	是	禁言类型： 1:直播间禁言 2:商家按时间禁言
content		string	是	用户发言内容
speakingTime		string	是	用户发言时间
roomId		int	是	直播间ID
roomCode		string	否	直播间编号
deadlineHour		int	type为2时必填	禁言时长(小时)

请求示例

直播间禁言:
{
    "sender": {
        "avatar": "https://static.public.hobbystock.cn/avatar/development/15161/1758260609488",
        "nickname": "1610",
        "id": 15161
    },
    "type": 1,
    "content": "11",
    "speakingTime": "2025-10-21 14:16:08",
    "roomCode": "",
    "roomId": 2777
}

商家禁言:
{
    "sender": {
        "avatar": "https://static.public.hobbystock.cn/avatar/development/15161/1758260609488",
        "nickname": "1610",
        "id": 15161
    },
    "type": 2,
    "roomId": 2777,
    "deadlineHour": 24
}

校验用户是否禁言

接口描述：用户发言时,校验是否被禁言

• 请求方法：POST
• Content-Type：application/json;
• 请求URL：/api/livechat/dispatch

请求参数

参数名称	参数	类型	必填	描述
sender	avatar	string	否	头像
	nickname	string	否	昵称
	id	int	是	用户编号
merchantId		int	是	商家编号 * 前端先传,后期后台通过 roomId取
content		string	是	用户发言内容
roomId		int	是	直播间ID

请求示例

直播间禁言:
{
    "sender": {
        "avatar": "https://static.public.hobbystock.cn/avatar/development/15161/1758260609488",
        "nickname": "1610",
        "id": 15161
    },
    "content": "你好",
    "roomId": 2777,
    "merchantId": 233
}