1.0.1 • Published 6 years ago

node-yunxin-im v1.0.1

Weekly downloads
3
License
MIT
Repository
github
Last release
6 years ago

yunxin-im

安装

$ npm install node-yunxin-im

使用

const YunxinIM = require('node-yunxin-im');
const yunxinIM = new YunxinIM('<你的AppKey>', '<你的AppSecret>');

// 创建用户
await yunxinIM.exec('user/create.action', {
  accid: 'accid',
  donnopOpen: false
});

// 创建群
await yunxinIM.exec('team/create.action', {
  tname: 'tname',
  owner: 'accid',
  members: JSON.stringify([]),
  msg: '邀请你来群',
  magree: 0,
  joinmode: 0
});

// path为/nimserver/的直接使用简化的命令就可以了
// path不为/nimserver/的需要指明全路径
// 例如: sms
await yunxinIM.exec('https://api.netease.im/sms/sendcode.action', {
  mobile: 'xxxxxxxxxxxx'
});

详细文档

测试

# 因为接口都相似,我只拿用户部分的接口作了测试
# 需要在test/1.user.js配置你的AppKey,AppSecret
$ mocha

错误码快查

code详细描述
200操作成功
201客户端版本不对,需升级sdk
301被封禁
302用户名或密码错误
315IP限制
403非法操作或没有权限
404对象不存在
405参数长度过长
406对象只读
408客户端请求超时
413验证失败(短信服务)
414参数错误
415客户端网络问题
416频率控制
417重复操作
418通道不可用(短信服务)
419数量超过上限
422账号被禁用
431HTTP重复请求
500服务器内部错误
503服务器繁忙
508消息撤回时间超限
509无效协议
514服务不可用
998解包错误
999打包错误
801群人数达到上限
802没有权限
803群不存在
804用户不在群
805群类型不匹配
806创建群数量达到限制
807群成员状态错误
808申请成功
809已经在群内
810邀请成功
9102通道失效
9103已经在他端对这个呼叫响应过了
11001通话不可达,对方离线状态
13001IM主连接状态异常
13002聊天室状态异常
13003账号在黑名单中,不允许进入聊天室
13004在禁言列表中,不允许发言
13005用户的聊天室昵称、头像或成员扩展字段被反垃圾
10431输入email不是邮箱
10432输入mobile不是手机号码
10433注册输入的两次密码不相同
10434企业不存在
10435登陆密码或帐号不对
10436app不存在
10437email已注册
10438手机号已注册
10441app名字已经存在