添加标签

Assigns a tag to a user in a chat.

POST /api/tags/add

Add a tag

cURL

curl --request POST \
  --url http://localhost:8080/api/tags/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bot_id": 1,
  "chat_id": -100123456789,
  "user_id": 987654321,
  "username": "alice",
  "tag": "VIP",
  "color": "#FFD700"
}
'

200

{
  "id": 123,
  "chat_id": 123,
  "user_id": 123,
  "username": "<string>",
  "tag": "<string>",
  "color": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

授权

BearerAuthCookieAuth

Authorization · string · header · 必填

API key with bmx_ prefix. Obtain via /api/auth/api-keys.

请求体

application/json

chat_id · integer · 必填

Chat to tag user in

user_id · integer · 必填

User to tag

tag · string · 必填

Tag label

bot_id · integer

Bot ID (for permission check)

username · string

Username at time of tagging

color · string

Tag color

响应

200

application/json

Tag created

id · integer

Tag record ID

chat_id · integer

Chat this tag belongs to

user_id · integer

User this tag is assigned to

username · string

Username at time of tagging

tag · string

Tag label text

color · string

Tag color (hex or CSS color name)

created_at · string<date-time>

When the tag was created