Interface SignalingInterface

示例

nim.signalingAccept({
  channelId: 'channel-123',
  account: 'inviter1',
  requestId: 'req-123',
  autoJoin: true
}).then(function() {
  console.log('接受邀请成功')
}).catch(function(err) {
  console.log('接受邀请失败', err)
})

注: 组合接口, 相当于调用 signalingCreateAndJoin 后, 调用 signalingInvite.

示例

nim.signalingCall({
  type: 1,
  channelName: 'audio-call-' + Date.now(),
  account: 'user1',
  requestId: 'req-' + Date.now(),
  pushInfo: {
    needPush: true,
    pushTitle: '语音通话',
    pushContent: '您有一个语音通话邀请'
  }
}).then(function(channel) {
  console.log('呼叫成功', channel)
}).catch(function(err) {
  console.log('呼叫失败', err)
})

注: 组合接口, 比 signalingCall 多了云信 G2 音视频相关的参数

示例

nim.signalingCallEx({
  type: 2,
  channelName: 'video-call-' + Date.now(),
  account: 'user1',
  requestId: 'req-' + Date.now(),
  nertcChannelName: 'rtc-room-123',
  pushInfo: {
    needPush: true,
    pushTitle: '视频通话',
    pushContent: '您有一个视频通话邀请'
  }
}).then(function(channel) {
  console.log('呼叫成功', channel)
}).catch(function(err) {
  console.log('呼叫失败', err)
})

示例

nim.signalingCancel({
  channelId: 'channel-123',
  account: 'user1',
  requestId: 'req-123'
}).then(function() {
  console.log('取消邀请成功')
}).catch(function(err) {
  console.log('取消邀请失败', err)
})

示例

nim.signalingClose({
  channelId: 'channel-123',
  offlineEnabled: true
}).then(function() {
  console.log('关闭频道成功')
}).catch(function(err) {
  console.log('关闭频道失败', err)
})

示例

nim.signalingControl({
  channelId: 'channel-123',
  attachExt: JSON.stringify({ action: 'mute-video' })
}).then(function() {
  console.log('发送自定义信令成功')
}).catch(function(err) {
  console.log('发送自定义信令失败', err)
})

示例

nim.signalingCreate({
  type: 2,
  channelName: 'my-channel-' + Date.now(),
  ext: JSON.stringify({ roomType: 'meeting' })
}).then(function(channel) {
  console.log('创建频道成功', channel)
}).catch(function(err) {
  console.log('创建频道失败', err)
})

注: 组合接口, 相当于调用 signalingCreate 后, 调用 signalingJoin.

示例

nim.signalingCreateAndJoin({
  type: 2,
  channelName: 'room-' + Date.now()
}).then(function(channel) {
  console.log('创建并加入频道成功', channel)
}).catch(function(err) {
  console.log('创建并加入频道失败', err)
})

示例

nim.signalingDelay({
  channelId: 'channel-123'
}).then(function(channel) {
  console.log('延长频道有效期成功', channel)
}).catch(function(err) {
  console.log('延长频道有效期失败', err)
})

示例

nim.signalingGetChannelInfo({
  channelName: 'my-channel-123'
}).then(function(channel) {
  console.log('查询频道信息成功', channel)
  console.log('频道成员', channel.members)
}).catch(function(err) {
  console.log('查询频道信息失败', err)
})

示例

nim.signalingInvite({
  channelId: 'channel-123',
  account: 'user1',
  requestId: 'req-' + Date.now(),
  pushInfo: {
    needPush: true,
    pushContent: '邀请您加入通话'
  }
}).then(function() {
  console.log('邀请成功')
}).catch(function(err) {
  console.log('邀请失败', err)
})

示例

nim.signalingJoin({
  channelId: 'channel-123'
}).then(function(channel) {
  console.log('加入频道成功', channel)
}).catch(function(err) {
  console.log('加入频道失败', err)
})

示例

nim.signalingJoinAndAccept({
  channelId: 'channel-123',
  account: 'inviter1',
  requestId: 'req-123',
  nertcChannelName: 'rtc-room-123'
}).then(function() {
  console.log('加入频道并接受邀请成功')
}).catch(function(err) {
  console.log('加入频道并接受邀请失败', err)
})

示例

nim.signalingLeave({
  channelId: 'channel-123'
}).then(function() {
  console.log('离开频道成功')
}).catch(function(err) {
  console.log('离开频道失败', err)
})

示例

nim.signalingMarkMsgRead({
  msgid: ['msg-1', 'msg-2']
}).then(function() {
  console.log('标记信令消息已读成功')
}).catch(function(err) {
  console.log('标记信令消息已读失败', err)
})

示例

nim.signalingReject({
  channelId: 'channel-123',
  account: 'inviter1',
  requestId: 'req-123',
  attachExt: JSON.stringify({ reason: '忙碌中' })
}).then(function() {
  console.log('拒绝邀请成功')
}).catch(function(err) {
  console.log('拒绝邀请失败', err)
})