修改房间内昵称

开发中

POST

https://chat.xiaoheihe.cn/chatroom/v2/room/nickname

请求参数

Authorization

在 header 添加参数

token

示例：

token: ********************

Query 参数

client_type

string

声明请求黑盒语音

必需

默认值:

heybox_chat

x_client_type

string

声明客户端类型

必需

默认值:

web

os_type

string

声明客户端类型

必需

默认值:

web

x_os_type

string

声明客户端是bot

必需

默认值:

bot

x_app

string

声明请求黑盒语音

必需

默认值:

heybox_chat

chat_os_type

string

声明客户端是bot

必需

默认值:

bot

chat_version

string

必需

客户端版本号,不同版本返回的结果可能有区别

默认值:

1.30.0

Header 参数

Content-Type

string

必需

示例值:

application/json;charset=UTF-8

Body 参数application/json

nickname

string

必需

room_id

string

必需

to_user_id

integer

必需

示例

{
  "nickname": "测试昵称",
  "room_id": "3587810143523774464",
  "to_user_id": 8828375
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://chat.xiaoheihe.cn/chatroom/v2/room/nickname?client_type=&x_client_type=&os_type=&x_os_type=&x_app=&chat_os_type=&chat_version=' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'token;' \
--data-raw '{
    "nickname": "测试昵称",
    "room_id": "3587810143523774464",
    "to_user_id": 8828375
}'

返回响应

🟢200成功

application/json

Body

msg

string

必需

result

object

必需

chatmobile_ack_id

string

必需

heychat_ack_id

string

必需

status

string

必需

示例

{
  "msg": "string",
  "result": {
    "chatmobile_ack_id": "string",
    "heychat_ack_id": "string"
  },
  "status": "string"
}

修改于 2024-10-24 04:16:51

房间相关接口文档

分页获取加入的房间列表