邀请机制

邀请别人加入频道

  var pushInfo = {
    needPush: true,
    pushTitle: 'title',
    pushContent: '你收到了邀请',
    pushPayload: { from: 111 },
    needBadge: true,
  }

  var param = {
    channelId: '2ed4a942417e4b33949f1b65739f3f00',
    account: 'cs3',
    requestId: '123',
    offlineEnabled: true,
    attachExt: '12',
    pushInfo: pushInfo
  }

  nim.signalingInvite(param).then(data => {
    console.warn("独立呼叫信令,邀请别人加入频道成功,data:", data)
  }).catch(error => {
    console.warn("独立呼叫信令,邀请别人加入频道失败,error:", error)
    switch (error.code) {
      case 10404:
        console.warn("独立呼叫信令:频道不存在")
        break
      case 10406:
        console.warn("独立呼叫信令:不在频道内(自己)")
        break
      case 10407:
        console.warn("独立呼叫信令:已经在频道内(对方)")
        break
      case 10419:
        console.warn("独立呼叫信令:频道人数超限")
        break
      case 10201:
        console.warn("独立呼叫信令:对方云信不在线")
        break
      case 10202:
        console.warn("独立呼叫信令:对方推送不可达");//  可能对方不在线也是返回的这个。
        break
    }
  })
param 类型 说明
channelId string 对应的频道id
account string 对方account账号
requestId string 邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled boolean 是否存离线通知
attachExt string 操作者(即被邀请者)附加的自定义信息,透传给其他人,可缺省
pushInfo object 推送信息
pushInfo推送消息 类型 说明
pushTitle string 推送标题
pushContent string 推送内容
pushPayload string 推送自定义字段,要求是json格式,Web支持Object对象类型
needPush boolean 是否需要推送,默认false
needBadge boolean 是否计入未读计数,默认true
error结果说明 类型 说明
code number 错误码 10404表示频道不存在 10406表示不在频道内(自己) 10407表示已经在频道内(对方) 10419表示频道人数超限 10201表示对方云信不在线 10202表示对方推送不可达
data结果说明 类型 说明
code number 错误码 200表示邀请别人加入频道成功

取消邀请别人加入频道

  var param = {
    channelId: '2ed4a942417e4b33949f1b65739f3f00',
    account: 'cs3',
    requestId: '123',
    offlineEnabled: true,
    attachExt: '11'
  }

  nim.signalingCancel(param).then(data=>{
    console.warn("独立呼叫信令,取消邀请别人加入频道成功,data:", data)
  }).catch(error=>{
    console.warn("独立呼叫信令,取消邀请别人加入频道失败,error:", error)
    switch (error.code) {
      case 10404:
        console.warn("独立呼叫信令:频道不存在")
        break
      case 10408:
        console.warn("独立呼叫信令:邀请不存在或已过期")
        break
      case 10409:
        console.warn("独立呼叫信令:邀请已经拒绝")
        break
      case 10410:
        console.warn("独立呼叫信令:邀请已经接受")
        break
    }  
  })
param 类型 说明
channelId string 对应的频道id
account string 对方account账号
requestId string 邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled boolean 是否存离线通知
attachExt string 操作者(即被邀请者)附加的自定义信息,透传给其他人,可缺省
error结果说明 类型 说明
code number 错误码 10404表示频道不存在 10408表示邀请不存在或已过期 10409表示邀请已经拒绝 10410表示邀请已经接受
data结果说明 类型 说明
code number 错误码 200表示取消邀请成功

接受邀请

  var param = {
    channelId: '2ed4a942417e4b33949f1b65739f3f00',
    account: 'cs3',
    requestId: '123',
    offlineEnabled: false,
    attachExt: '12',
    autoJoin: false,
    uid: '123',
    joinAttachExt: 'join ext'
  }

  nim.signalingAccept(param).then(data=>{
    console.warn("独立呼叫信令,接受别人的邀请,data:", data)
    if(autoJoin) {
      console.warn("独立呼叫信令,接受别人的邀请后,自动加入频道成功,data:", data)
    }
  }).catch(error=>{
    console.warn("独立呼叫信令,取消邀请别人加入频道失败,error:", error)
    if (error.code == 10404) {
      console.warn("独立呼叫信令:频道不存在");
    } else if (error.code == 10408) {
      console.warn("独立呼叫信令:邀请不存在或已过期");
    } else if (error.code == 10409) {
      console.warn("独立呼叫信令:邀请已经拒绝");
    } else if (error.code == 10410) {
      console.warn("独立呼叫信令:邀请已经接受");
    } else if (error.code == 10201) {
      console.warn("独立呼叫信令:对方不在线");
    } 
  })
param 类型 说明
channelId string 对应的频道id
account string 邀请的account账号
requestId string 邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled boolean 是否存离线通知
attachExt string 操作者附加的自定义信息,透传给其他人,可缺省
autoJoin boolean 是否自动加入频道,默认不打开,打开后后续参数uid、joinAttachExt有效
uid string 自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid,可缺省
joinAttachExt string 加入频道的自定义扩展信息,将在加入频道通知中带给其他频道成员,可缺省
error结果说明 类型 说明
code number 错误码 10404表示频道不存在 10408表示邀请不存在或已过期 10409表示邀请已经拒绝 10410表示邀请已经接受 10201表示对方不在线
data结果说明 类型 说明
code number 错误码 200表示接受邀请成功
channelInfo object 频道信息,创建频道接口中有说明格式
members array 频道里的成员列表,加入频道的接口中有说明格式

拒绝邀请

  var param = {
    channelId: channelId,
    account: account,
    requestId: requestId,
    offlineEnabled: offlineEnabled,
    attachExt: ext
  }

  nim.signalingReject(param).then(data=>{
    console.warn("独立呼叫信令,拒绝别人的邀请,data:", data)
  }).catch(error=>{
    console.warn("独立呼叫信令,拒绝别人的邀请失败,error:", error)
    if (error.code == 10404) {
      console.warn("独立呼叫信令:频道不存在");
    } else if (error.code == 10408) {
      console.warn("独立呼叫信令:邀请不存在或已过期");
    } else if (error.code == 10409) {
      console.warn("独立呼叫信令:邀请已经拒绝");
    } else if (error.code == 10410) {
      console.warn("独立呼叫信令:邀请已经接受");
    } else if (error.code == 10201) {
      console.warn("独立呼叫信令:对方不在线");
    } 
  })
param 类型 说明
channelId string 对应的频道id
account string 邀请者的account账号
requestId string 邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled boolean 是否存离线通知
attachExt string 操作者附加的自定义信息,透传给其他人,可缺省
error结果说明 类型 说明
code number 错误码 10404表示频道不存在 10408表示邀请不存在或已过期 10409表示邀请已经拒绝 10410表示邀请已经接受 10201表示对方不在线
data结果说明 类型 说明
code number 错误码 200表示接受邀请成功
channelInfo object 频道信息,创建频道接口中有说明格式
members array 频道里的成员列表,加入频道的接口中有说明格式

呼叫信令

  var pushInfo = {
    needPush: pushEnableNode.checked ? 1 : 0,
    pushTitle: customNotificationNode.value,
    pushContent: pushContentNode.value,
    pushPayload: payloadNode.value,
    needBadge: pushNeedBadgeNode.checked ? 1 : 0,
  }

  var param = {
    type: type,
    channelName: channelName,
    ext: ext,
    channelId: channelId,
    uid: uid,
    account: account,
    requestId: requestId,
    offlineEnabled: offlineEnabled,
    attachExt: joinExt,
    pushInfo: pushInfo
  }

  nim.signalingCall(param).then(data=>{
    console.warn("独立呼叫信令,呼叫成功:", data)
  }).catch(error=>{
    console.warn("独立呼叫信令,呼叫失败:", error)
    if (error.code == 10405) {
      console.warn("独立呼叫信令:频道已存在");
    } else if (error.code == 10201) {
      console.warn("独立呼叫信令:对方云信不在线");
    } else if (error.code == 10202) {
      console.warn("独立呼叫信令:对方推送不可达");
    } 
  })
param 类型 说明
type number 通话类型,1:音频;2:视频;3:其他
channelName string 频道名,可缺省
ext string 频道的自定义扩展信息,可缺省
uid string 自己在频道中对应的uid,大于零有效,无效时服务器会分配随机唯一的uid
account string 邀请的对方account账号
requestId string 邀请者邀请的请求id,需要邀请者填写,之后取消邀请、拒绝、接受需要复用该requestId
offlineEnabled boolean 是否存离线通知
attachExt string 操作者附加的自定义信息,透传给其他人,可缺省
pushInfo object 推送信息
pushInfo推送消息 类型 说明
pushTitle string 推送标题
pushContent string 推送内容
pushPayload string 推送自定义字段,要求是json格式,否则推送会产生错误
needPush boolean 是否需要推送,默认false
needBadge boolean 是否计入未读计数,默认true
error结果说明 类型 说明
code number 错误码 10405表示频道已存在 10201表示对方云信不在线 10202表示对方推送不可达
data结果说明 类型 说明
code number 错误码 200表示接受邀请成功
channelInfo object 频道信息,创建频道接口中有说明格式
members array 频道里的成员列表,加入频道的接口中有说明格式