Wildfire IM

https://docs.wildfirechat.cn/
Admin
Wildfire IM is a general-purpose instant messaging and real-time communication platform that enables...
Tokens:476,225
Snippets:2,719
Trust Score:5.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create or Update Device Example Request and Response

Source: https://docs.wildfirechat.cn/server/admin_api/user_api.html

Example curl command to create or update a device, followed by the expected JSON response containing the device ID, token, and secret.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"deviceId\":\"device1\",       \
    \"owners\":[\"user1\",\"user2\"],                        \
    \"extra\":\"extra info\"                        \
  }"                                \
  http://localhost:18080/admin/device/create_or_update
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
    "deviceId":"device1",
    "token":"token123",
    "secret":"secret456"
  }
}
```

--------------------------------

### Get robot info - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/user_api.html

Example curl command to get robot info for robotId 'a', followed by the JSON response with robot details. Note: the response example has a missing comma after 'owner' field, which is a typo in the source.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"robotId\":\"a\"}" http://localhost:18080/admin/user/get_robot_info

{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "name":"usera",
    "owner":"userId2"
    "secret":"123456"
  }
}

```

--------------------------------

### 配置Config.java的IM服务器地址

Source: https://docs.wildfirechat.cn/faq/android/q2.html

在调用WfcUIKit#init之前，对Config类的字段进行赋值，例如设置IM服务器主机地址。

```java
Config.IM_SERVER_HOST = "im.example.com";
...
```

--------------------------------

### 安装编译依赖（python和build-essential）

Source: https://docs.wildfirechat.cn/blogs/%E5%9B%BD%E4%BA%A7%E5%8C%96%E7%B3%BB%E7%BB%9F%E9%B2%B2%E9%B9%8FCPU%2BUOS%E9%80%82%E9%85%8D%E7%BB%8F%E5%8E%86.html

在UOS上通过apt命令安装编译所需的依赖包。需要先打开开发者模式。

```bash
sudo apt update
sudo apt install python，build-essential

```

--------------------------------

### Get group remark - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/group_api.html

Example curl request to get a group remark. The body includes userId, scope=26, and key=groupId. The response returns the remark in the value field.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"userId\":\"user1\",       \
    \"scope\": 26,    \
    \"key\": \"groupId1\"   \
    }"                                \
  http://localhost:18080/admin/user/get_setting
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
    "scope":26,
    "key":"groupId1",
    "value":"重要群组"
  }
}
```

--------------------------------

### Get user online status - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/user_api.html

Example curl command to get online status for user 'a', followed by the JSON response showing session details. The response includes a list of sessions with clientId, userId, platform, status (0 online, 1 offline), and lastSeen.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost:18080/admin/user/onlinestatus

{
  "code":0,
  "msg":"success",
  "result":[{
    "clientId":"clientidxxx",
    "userId":"useridxxx",
    "platform":0,
    "status":0,
    "lastSeen":1392312342
  }]
}

```

--------------------------------

### 注册用户通知设置

Source: https://docs.wildfirechat.cn/ios/ios_integration.html

在application:didFinishLaunchingWithOptions:中注册用户通知设置，兼容iOS 10及以上和旧版本。

```objectivec
if (@available(iOS 10.0, *)) {
 //第一步：获取推送通知中心
 UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
 center.delegate = self;
 [center requestAuthorizationWithOptions:(UNAuthorizationOptionAlert|UNAuthorizationOptionSound|UNAuthorizationOptionBadge)
                       completionHandler:^(BOOL granted, NSError * _Nullable error) {
                           if (!error) {
                               NSLog(@"succeeded!");
                               dispatch_async(dispatch_get_main_queue(), ^{
                                   [application registerForRemoteNotifications];
                               });
                           }
                       }];
} else {
 UIUserNotificationSettings *settings = [UIUserNotificationSettings
                                         settingsForTypes:(UIUserNotificationTypeBadge |
                                                           UIUserNotificationTypeSound |
                                                           UIUserNotificationTypeAlert)
                                         categories:nil];
 [application registerUserNotificationSettings:settings];
}

```

--------------------------------

### Get common groups of two users - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/group_api.html

Example for POST /admin/group/common_group. The request body requires 'first' and 'second' user IDs. The response contains a 'groupIds' list. This endpoint is not recommended for high-frequency use due to performance concerns.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"first\":\"userId1\",    \
    \"second\":\"userId2\",    \
    }"                                \
  http://localhost:18080/admin/group/common_group
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
    "groupIds":["groupId1", "groupId2", "groupId3"]
  }
}
```

--------------------------------

### wf.ready

Source: https://docs.wildfirechat.cn/open/jssdk.html

config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。

```APIDOC
## wf.ready

### Description
config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。

### Method
ready

### Parameters
#### Callback
- **callback** (function) - 必填 - 验证成功后的回调函数

### Request Example
```
wf.ready(function(){
  // config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。
});
```

### Response
#### Success Response
- **errMsg** (string) - 调用成功时："xxx:ok"，其中xxx为调用的接口名

#### Response Example
```
{
  "errMsg": "ready:ok"
}
```

### Error Handling
- 调用失败时：errMsg为具体错误信息
```

--------------------------------

### Get single moment - curl example

Source: https://docs.wildfirechat.cn/server/robot_api/moments_api.html

Curl command to retrieve a moment with feedId 123456789, followed by the JSON response containing the moment details.

```bash
curl -X POST -H "nonce:76616" -H "timestamp\":\"1558350862502\" -H "sign\":\"b98f9b0717f59febccf1440067a7f50d9b31bdde\" -H "Content-Type:application/json" -H "rid":"robota" -d \"{\\\"feedId\\\":123456789}\" http://localhost/robot/moments/feed/pull_one

{
  "code":0,
  "msg":"success",
  "result":{
    "feedId":123456789,
    "sender\":\"user1\",
    "text\":\"今天天气真好！\",
    "timestamp\":13123423234324
  }
}

```

--------------------------------

### 修改 /etc/systemd/system.conf 设置 DefaultLimitNOFILE

Source: https://docs.wildfirechat.cn/server/system_tune.html

在 /etc/systemd/system.conf 中设置 DefaultLimitNOFILE 以调整系统服务文件描述符限制。

```bash
DefaultLimitNOFILE=1000000

```

--------------------------------

### Get all users (paginated) - curl example

Source: https://docs.wildfirechat.cn/server/admin_api/user_api.html

Sends a POST request to /admin/user/all with a JSON body containing count and offset for pagination. The response includes a list of users.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"count\":10,\"offset\":0}" http://localhost:18080/admin/user/all
```

```json
{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"user1",
      "name":"name1"
    }
  ]
}
```

--------------------------------

### Get chatroom blacklist - curl example

Source: https://docs.wildfirechat.cn/server/admin_api/chatroom_api.html

Sends a POST request to /admin/chatroom/get_black_status with a chatroomId. The response includes a list of blacklist entries with userId, state, and optional expiredTime.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"chatroomId\":\"aaaa\"}" http://localhost:18080/admin/chatroom/get_black_status

{
  "code":0,
  "msg":"success",
  "result":{
    infos:[
      {"userId":"user1","state":1,expiredTime:0},
      {"userId":"user2","state":2,expiredTime:365400}
    ]
  }

}
```

--------------------------------

### wf.ready 处理成功验证

Source: https://docs.wildfirechat.cn/open/jssdk.html

处理config验证成功后的回调，所有接口调用都必须在config接口获得结果之后。若需在页面加载时调用接口，应将其放在ready函数中。

```javascript
wf.ready(function(){
  // config信息验证后会执行ready方法，所有接口调用都必须在config接口获得结果之后，config是一个客户端的异步操作，所以如果需要在页面加载时就调用相关接口，则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口，则可以直接调用，不需要放在ready函数中。
});
```

--------------------------------

### Get user by email - curl example

Source: https://docs.wildfirechat.cn/server/admin_api/user_api.html

Sends a POST request to /admin/user/get_info_by_email with a JSON body containing the email address. The response includes a list of users matching that email.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "\"user1@example.com\"" http://localhost:18080/admin/user/get_info_by_email
```

```json
{
  "code":0,
  "msg":"success",
  "result":[
    {
      "userId":"user1",
      "name":"name1",
      "email":"user1@example.com"
    }
  ]
}
```

--------------------------------

### 七牛云存储配置示例

Source: https://docs.wildfirechat.cn/server/oss_config_sample.html

配置七牛云作为媒体服务器，需设置上传地址（如up.qbox.me）、端口、访问密钥和各个bucket的名称及域名。注意server_host不能带http头和port，port配置在media.server_port和media.server_ssl_port属性。

```properties
## qiniu media server configuration
## 上传地址，不同的区域，上传地址也不同，七牛文档上有区域和地址的对应关系，华东地区默认是up.qbox.me。
## server_host与社区版不同，不能带http头和port。port配置在media.server_port和media.server_ssl_port属性。
media.server_host  up.qbox.me
media.server_port 80
media.server_ssl_port 443
media.access_key tU3vdBK5BL5j4N7jI5N5uZgq_HQDo170w5C9Amnn
media.secret_key YfQIJdgp5YGhwEw14vGpaD2HJZsuJldWtqens7i5
## bucket名字及Domain
media.bucket_general_name media
media.bucket_general_domain http://cdn.wildfirechat.cn
media.bucket_image_name media
media.bucket_image_domain http://cdn.wildfirechat.cn
media.bucket_voice_name media
media.bucket_voice_domain http://cdn.wildfirechat.cn
media.bucket_video_name media
media.bucket_video_domain http://cdn.wildfirechat.cn
media.bucket_file_name media
media.bucket_file_domain http://cdn.wildfirechat.cn
media.bucket_sticker_name media
media.bucket_sticker_domain http://cdn.wildfirechat.cn
media.bucket_moments_name media
media.bucket_moments_domain http://cdn.wildfirechat.cn
media.bucket_portrait_name storage
media.bucket_portrait_domain http://cdn2.wildfirechat.cn
media.bucket_favorite_name storage
media.bucket_favorite_domain http://cdn2.wildfirechat.cn

```

--------------------------------

### 修改 /etc/security/limits.conf 设置用户文件句柄限制

Source: https://docs.wildfirechat.cn/server/system_tune.html

在 /etc/security/limits.conf 中设置用户允许打开的最大文件句柄数。

```bash
*      soft   nofile      1000000
*      hard   nofile      1000000

```

--------------------------------

### Get friend alias (get_alias) - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/user_relation.html

Retrieves the alias for a friend relationship. The request body includes operator and targetId. The response includes the alias in the result object.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"operator\":\"a\",\"targetId\":\"a\"}" http://localhost:18080/admin/friend/get_alias
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
      "operator":"a",
      "targetId":"b",
      "alias":"Mr.Hello"
  }
}
```

--------------------------------

### 初始化WFCCNetworkService

Source: https://docs.wildfirechat.cn/ios/ios_integration.html

在application:didFinishLaunchingWithOptions:中启动日志、设置代理和服务器地址。

```objectivec
[WFCCNetworkService startLog];
[WFCCNetworkService sharedInstance].connectionStatusDelegate = self;
[WFCCNetworkService sharedInstance].receiveMessageDelegate = self;
[[WFCCNetworkService sharedInstance] setServerAddress:IM_SERVER_HOST];

```

--------------------------------

### Get user group list by member type - curl example and response

Source: https://docs.wildfirechat.cn/server/admin_api/group_api.html

Example for POST /admin/group/of_user_by_type. The request body requires 'userId' and 'groupMemberType' (array of ints: 0 normal member, 1 admin, 2 owner). The response contains a 'groupIds' list. This endpoint is not recommended for high-frequency use due to performance concerns.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"userId\":\"userId1\",    \
    \"groupMemberType\":[0, 2]    \
    }"                                \
  http://localhost:18080/admin/group/of_user_by_type
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
    "groupIds":["groupId1", "groupId2"]
  }
}
```

--------------------------------

### 配置 turnserver.conf

Source: https://docs.wildfirechat.cn/webrtc/turn_server.html

修改turnserver配置文件，设置监听IP、中继IP、外部IP、用户密码和UDP端口范围。默认配置模板位于/usr/local/etc/turnserver.conf.default，需要复制为/usr/local/etc/turnserver.conf。如果服务器只有一个IP，内网IP和外网IP使用同一个IP。

```ini
listening-ip=${内网IP}
relay-ip=${内网IP}
external-ip=${外网IP}

user=username:password

min-port=49152
max-port=65535

```

--------------------------------

### Get user relation - curl example

Source: https://docs.wildfirechat.cn/server/admin_api/user_relation.html

Retrieves the relationship between two users via the /admin/relation/get endpoint. The request includes operator and targetId parameters. The response contains user details such as alias, isFriend, and isBlacked.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"operator\":\"a\",\"targetId\":\"a\"}" http://localhost:18080/admin/relation/get
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
      "userId":"a",
      "targetId":"b",
      "alias":"Mr.Hello",
      "isFriend":true
  }
}
```

--------------------------------

### 启动 MCP 服务（stdio 和 HTTP 模式）

Source: https://docs.wildfirechat.cn/blogs/%E9%87%8E%E7%81%AB%E6%9C%BA%E5%99%A8%E4%BA%BAMCP%E6%9C%8D%E5%8A%A1%E7%AE%80%E4%BB%8B.html

通过 npm start 启动服务。本地模式直接运行，HTTP 模式需先设置 WF_MCP_PORT 环境变量指定端口。

```shell
# 本地模式
npm start

# HTTP 模式
export WF_MCP_PORT=3100
npm start

```

--------------------------------

### Get User Group List - curl Example

Source: https://docs.wildfirechat.cn/server/admin_api/group_api.html

POST request to /admin/group/of_user with a userId parameter. The response includes a result object with a list of groupIds. This endpoint is not recommended for high-frequency use due to potential performance issues.

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"userId\":\"userId1\"    \
    }"                                \
  http://localhost:18080/admin/group/of_user
```

```json
{
  "code":0,
  "msg":"success",
  "result":{
    "groupIds":["groupId1", "groupId2", "groupId3"]
  }
}
```

--------------------------------

### POST /admin/user/get_setting

Source: https://docs.wildfirechat.cn/server/admin_api/general_api.html

获取用户设置，仅专业版IM服务支持此接口。

```APIDOC
## POST /admin/user/get_setting

### Description
获取用户设置，仅专业版IM服务支持此接口。

### Method
POST

### Endpoint
http://domain:18080/admin/user/get_setting

### Parameters
#### Request Body
- **userId** (string) - 必需 - 用户ID
- **scope** (int) - 必需 - 设置类型
- **key** (string) - 可选 - 设置的Key值

### Request Example
```
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\",\"scope\":1001,\"key\":\"b\",\"value\":\"c\"}" http://localhost:18080/admin/user/get_setting
```

### Response
#### Success Response (200)
- **userId** (string) - 用户ID
- **scope** (int) - 设置类型
- **key** (string) - 设置的Key值
- **value** (string) - 设置的Value

#### Response Example
```
{
  "code":0,
  "msg":"success",
  "result":{
    "userId":"a",
    "scope":1001,
    "key":"b",
    "value":"c"
  }
}
```
```

--------------------------------

### Get blacklist list via /admin/blacklist/list

Source: https://docs.wildfirechat.cn/server/admin_api/user_relation.html

Retrieves the blacklist for a given user. The endpoint is POST /admin/blacklist/list. The example shows a curl request with the required userId in the body and the response containing a result array of blacklisted UIDs.

```text
http://domain:18080/admin/blacklist/list
```

```bash
curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d "{\"userId\":\"a\"}" http://localhost:18080/admin/blacklist/status

{
  "code":0,
  "msg":"success",
  "result":[
    "b"
  ]
}
```

--------------------------------

### AVEngineKit.init

Source: https://docs.wildfirechat.cn/blogs/AVENGINE_DEVELOPER_GUIDE.html

Initializes the AVEngineKit with a RobotService and a callback for engine events.

```APIDOC
## AVEngineKit.init

### Description
Initializes the AVEngineKit with a RobotService and a callback for engine events.

### Method
init

### Signature
public void init(RobotService robotService, AVEngineKitCallback engineKitCallback)

### Parameters
- **robotService** (RobotService) - Required - The robot service instance.
- **engineKitCallback** (AVEngineKitCallback) - Required - Callback for engine events.

```
Tokens:
Raw