API 参考
圈组

拒绝邀请

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

云信服务端提供 API,支持拒绝“加入服务器”的邀请。

功能介绍

被邀请后,受邀方将收到邀请加入服务器的系统通知。受邀方可调用服务端 API 拒绝邀请。受邀方拒绝邀请后,邀请方会收到一条“拒绝邀请”(SERVER_MEMBER_INVITE_REJECT(2))的系统通知。

调用时机

收到“邀请服务器成员”(SERVER_MEMBER_INVITE(1))的系统通知时。

URL

httpPOST https://api.netease.im/nimserver/qchat/rejectServerInvite.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accidString受邀方的 IM 账号
serverIdLong服务器 ID
inviteAccidString邀请者的 IM 帐号
msgString拒绝邀请的消息内容,最大长度 150 字符
requestIdLong邀请 ID

示例代码

cURL 请求示例

curlcurl -X POST -H "AppKey: go9dnk49bk**lw0803mgq3" -H "Nonce: 4tggg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid=zhangsan&inviteAccid=lisi&msg=reject' 'https://api.netease.im/nimserver/qchat/rejectServerInvite.action'

返回示例

HTTP 响应:JSON

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务相关的状态码。完整状态码请参见状态码

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限 检查是否已开通圈组功能
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的服务器 ID、 IM 账号或邀请 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • 调用时机
  • URL
  • 请求参数
  • 示例代码
  • cURL 请求示例
  • 返回示例
  • 状态码