独立信令服务器API

创建信令房间

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

创建一个独立信令房间

参数说明

参数类型必须说明
channelNamestring 房间名称,应用内唯一,如不传服务器会自动生成一个
type int 1表示音频,2表示视频,3表示自定义
from string 创建者accid
ext string 自定义扩展字段,最大4096字符
isRoute int 是否抄送,0表示不抄送,1表示抄送,默认不抄送

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'type=0&from=abc' 'https://api.netease.im/nimserver/nrtc/createChannel.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": {
    "ext": "ext",
    "creator": "acc",
    "channelCreateTime": 1574847138426,
    "members": [],
    "channelName": "70d341d0b257473899a73abff78e47a3",
    "type": "AUDIO",
    "channelExpireTime": 1574854338428,
    "channelId": "fead099e076f4ea8ae8d33e2ea31bdf6"
  }
}

主要的返回码

200、403、414、10405、500

具体请参考code状态表

延长信令房间的有限期

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

延长信令房间的有限期

参数说明

参数类型必须说明
channelIdstring 房间id

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=abc' 'https://api.netease.im/nimserver/signal/delayRoom.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": {
    "ext": "ext",
    "creator": "acc",
    "channelCreateTime": 1574847410965,
    "members": [
      {
        "uid": 1000,
        "expireTime": 1574848411103,
        "createTime": 1574847411103,
        "accid": "acc2",
        "deviceId": "asasassa"
      }
    ],
    "channelName": "45f9e9427d844204b9ff228565c16f51",
    "type": "AUDIO",
    "channelExpireTime": 1574854611000,
    "channelId": "f818b543e7134338b2975fa1c12273fb"
  }
}

主要的返回码

200、403、414、10404、500

具体请参考code状态表

关闭信令房间

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

关闭信令房间

参数说明

参数类型必须说明
channelIdstring 房间id
from string 操作者
attachExt string 通知扩展字段
isSave int 通知是否存离线,0表示不存离线,1表示存离线,默认不存
isRoute int 是否抄送,0表示不抄送,1表示抄送,默认不抄送

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=abc&from=xxx' 'https://api.netease.im/nimserver/signal/closeRoom.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、10404、10406、500

具体请参考code状态表

信令控制指令

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

信令控制指令

参数说明

参数类型必须说明
channelIdstring 房间id
from string 控制指令发送者accid,必须是房间内的人,或者房间创建者,可以缺省
to string 控制指令接受者accid,必须是房间内的人,或者房间创建者,可以缺省,缺省时表示对房间内的所有人进行广播
attachExt string 通知扩展字段
isRoute int 是否抄送,0表示不抄送,1表示抄送,默认不抄送

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=abc&from=xxx&to=yyy&attachExt=hhh' 'https://api.netease.im/nimserver/signal/ctrlRoom.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、10404、10406、500

具体请参考code状态表

查询信令房间信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查询信令房间信息

参数说明

参数类型必须说明
channelNamestring 房间名称,和房间id二选一,优先房间id
channelIdstring 房间id,和房间名称二选一,优先房间id

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=abc' 'https://api.netease.im/nimserver/signal/getRoomInfo.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": {
    "ext": "ext",
    "creator": "acc",
    "channelCreateTime": 1574847410965,
    "members": [
      {
        "uid": 1000,
        "expireTime": 1574848411103,
        "createTime": 1574847411103,
        "accid": "acc2",
        "deviceId": "asasassa"
      }
    ],
    "channelName": "45f9e9427d844204b9ff228565c16f51",
    "type": "AUDIO",
    "channelExpireTime": 1574854611000,
    "channelId": "f818b543e7134338b2975fa1c12273fb"
  }
}

主要的返回码

200、403、414、10404、10406、500

具体请参考code状态表