API 参考
圈组

在线状态订阅

更新时间: 2024/07/17 17:57:35

网易云信 IM 服务端支持订阅/取消订阅在线状态事件。

订阅在线状态事件

功能描述

订阅指定用户的在线状态事件,每个账号的有效订阅账号最多为 3000 个。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST https://api.netease.im/nimserver/event/subscribe/add.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accid String 事件订阅人账号
eventType int 事件类型,固定设置为1,即 eventType=1
publisherAccids String被订阅人的账号列表,最多100个账号,JSONArray格式。示例:["pub_user1","pub_user2"]
ttl long 订阅的有效时间,单位:秒。取值范围:60~2592000(即60秒到30天)

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: fc04024***230155c" -H "AppKey: f123***aaaa" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=user1&eventType=1&publisherAccids=["pub_user1","pub_user2"]&ttl=86400' "https://api.netease.im/nimserver/event/subscribe/add.action"

返回示例

json
"Content‐type":"application/json;charset=utf‐8"
{
  "code": 200,
  "failedAccid":[] //订阅失败的账号数组
}

查询在线状态事件订阅关系

功能描述

查询指定人用户的有效在线状态事件订阅关系。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST https://api.netease.im/nimserver/event/subscribe/query.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accid String 事件订阅人账号
eventType int 事件类型,固定设置为1,即 eventType=1
publisherAccids String被订阅人的账号列表,最多100个账号,JSONArray格式。示例:["pub_user1","pub_user2"]

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: fc04***0155c" -H "AppKey: f1234540***7aaaaaa" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=user1&eventType=1&publisherAccis=["pub_user1","pub_user2"]' "https://api.netease.im/nimserver/event/subscribe/query.action"

返回示例

json
"Content‐type":"application/json;charset=utf‐8"
{
  "code": 200,
  "subscribes":[
    {"accid":"pub_user1",//被订阅人账号
     "eventType":1, //事件类型
     "expireTime":1490341879766,  //过期时间
     "subscribeTime":1490255479766 //订阅时间
    },
    ...
  ]
}

取消在线状态事件订阅

功能描述

取消订阅指定用户的在线状态事件

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST https://api.netease.im/nimserver/event/subscribe/delete.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accid String 事件订阅人账号
eventType int 事件类型,固定设置为1,即 eventType=1
publisherAccids String取消被订阅人的账号列表,最多100个账号,JSONArray格式。示例:["pub_user1","pub_user2"]

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: fc040***0155c" -H "AppKey: f1***47aaaaaa" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=user1&eventType=1&publisherAccids=["pub_user1","pub_user2"]' "https://api.netease.im/nimserver/event/subscribe/delete.action"

返回示例

json
"Content‐type":"application/json;charset=utf‐8"
{
  "code": 200,
  "failedAccid":[] //取消订阅失败的账号数组
}

取消全部在线状态事件订阅

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

POST https://api.netease.im/nimserver/event/subscribe/batchdel.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考接口概述
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accid String 事件订阅人账号
eventType int 事件类型,固定设置为1,即 eventType=1

示例

请求示例(curl)

curlcurl -X POST -H "CheckSum: fc04***155c" -H "AppKey: f123***aaaaa" -H "Nonce: 1" -H "CurTime: 1451200147" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=user1&eventType=1' "https://api.netease.im/nimserver/event/subscribe/batchdel.action"

返回示例

json
"Content‐type":"application/json;charset=utf‐8"
{
  "code": 200
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 订阅在线状态事件
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 查询在线状态事件订阅关系
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 取消在线状态事件订阅
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 取消全部在线状态事件订阅
  • API 使用限制
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 返回示例
  • 状态码