信令
服务端API文档
更新时间: 2023/01/13 15:02:49
创建信令频道
创建一个独立信令频道。
URL
POST https://api.netease.im/nimserver/signal/createRoom.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
channelName | String | 否 | 频道名称,应用内唯一,如不传服务器会自动生成一个。长度限制:128 字符 |
type | Integer | 是 | 频道类型,1表示音频,2表示视频,3表示自定义 |
from | String | 是 | 创建者accid |
ext | String | 否 | 自定义扩展字段。长度限制:4096 字符 |
isRoute | Integer | 否 | 是否抄送,0表示不抄送,1表示抄送,默认不抄送 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
data | String | 频道的详细信息,详见具体参数说明 |
data 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
channelName | String | 频道名称 |
type | String | 频道类型,AUDIO:音频;VEDIO:视频;CUSTOM:自定义 |
channelId | String | 频道 ID,服务器生成,确保唯一 |
channelCreateTime | Long | 频道创建时间 |
channelExpireTime | Long | 频道过期时间 |
creator | String | 频道创建者账号,accid |
members | String | 频道成员列表,JSONArray 格式,一个元素表示一个成员信息,包括成员账号(accid),服务器生成的成员ID(uid),加入频道时间(createTime),过期时间(expireTime)以及设备ID(deviceId) |
ext | String | 扩展字段 |
示例
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/signal/createRoom.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"//频道ID
}
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码。
延长信令频道的有限期
延长信令频道的有限期。
URL
POST https://api.netease.im/nimserver/signal/delayRoom.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
channelId | String | 是 | 频道ID |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
data | String | 频道的详细信息,详见具体参数说明 |
data 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
channelName | String | 频道名称 |
type | String | 频道类型,AUDIO:音频;VEDIO:视频;CUSTOM:自定义 |
channelId | String | 频道 ID,服务器生成,确保唯一 |
channelCreateTime | Long | 频道创建时间 |
channelExpireTime | Long | 频道过期时间 |
creator | String | 频道创建者账号,accid |
members | String | 频道成员列表,JSONArray 格式,一个元素表示一个成员信息,包括成员账号(accid),服务器生成的成员ID(uid),加入频道时间(createTime),过期时间(expireTime)以及设备ID(deviceId) |
ext | String | 扩展字段 |
示例
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,//成员uid
"expireTime": 1574848411103,//过期时间
"createTime": 1574847411103,//加入时间
"accid": "acc2",//成员accid
"deviceId": "asasassa"//设备ID
}
],
"channelName": "45f9e9427d844204b9ff228565c16f51",//频道名称
"type": "AUDIO",//频道类型
"channelExpireTime": 1574854611000,//过期时间
"channelId": "f818b543e7134338b2975fa1c12273fb"//频道ID
}
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码。
关闭信令频道
关闭信令频道。
URL
POST https://api.netease.im/nimserver/signal/closeRoom.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
channelId | String | 是 | 频道ID |
from | String | 是 | 操作者accid |
attachExt | String | 否 | 通知扩展字段,最大4096字符 |
isSave | Integer | 否 | 通知是否存离线,0表示不存离线,1表示存离线,默认不存 |
isRoute | Integer | 否 | 是否抄送,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
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码。
发送控制指令
在频道中发送控制指令。
URL
POST https://api.netease.im/nimserver/signal/ctrlRoom.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
channelId | String | 是 | 频道ID |
from | String | 是 | 控制指令发送者账号,accid,必须是频道内的人,或者频道创建者,可以缺省 |
to | String | 是 | 控制指令接受者账号,accid,必须是频道内的人,或者频道创建者,可以缺省,缺省时表示对频道内的所有人进行广播 |
attachExt | String | 否 | 通知扩展字段,最大4096字符 |
isRoute | Integer | 否 | 是否抄送,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
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码。
查询信令频道信息
查询信令频道信息。
URL
POST https://api.netease.im/nimserver/signal/getRoomInfo.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求中Headers的设置请参考接口概述
请求参数
-
POST 请求中 Headers 的设置请参见API调用方式。
-
POST 请求中 Body 的设置如下:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
channelName | String | 否 | 频道名称,频道名称和频道ID,必须填一个,若都填,优先取频道ID |
channelId | String | 否 | 频道ID,频道名称和频道ID,必须填一个,若都填,优先取频道ID |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | Integer | 状态码 |
data | String | 频道的详细信息,详见具体参数说明 |
data 中的参数说明
参数 | 类型 | 说明 |
---|---|---|
channelName | String | 频道名称 |
type | String | 频道类型,AUDIO:音频;VEDIO:视频;CUSTOM:自定义 |
channelId | String | 频道 ID,服务器生成,确保唯一 |
channelCreateTime | Long | 频道创建时间 |
channelExpireTime | Long | 频道过期时间 |
creator | String | 频道创建者账号,accid |
members | String | 频道成员列表,JSONArray 格式,一个元素表示一个成员信息,包括成员账号(accid),服务器生成的成员ID(uid),加入频道时间(createTime),过期时间(expireTime)以及设备ID(deviceId) |
ext | String | 扩展字段 |
示例
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, //成员 uid
"expireTime": 1574848411103,//过期时间
"createTime": 1574847411103,//加入时间
"accid": "acc2",//成员accid
"deviceId": "asasassa"//设备ID
}
],
"channelName": "45f9e9427d844204b9ff228565c16f51",//频道名称
"type": "AUDIO",//频道类型
"channelExpireTime": 1574854611000,//过期时间
"channelId": "f818b543e7134338b2975fa1c12273fb"//频道ID
}
}
状态码
该接口在 HTTPS Body 中返回请求的状态码,状态码列表请参考状态码。
状态码
错误码 | 说明 |
---|---|
10201 | 执行的操作已经成功,只是对方不在线(推送可达,但是离线) |
10202 | 执行的操作已经成功,只是对方推送不可达 |
10404 | 对应的频道不存在 |
10405 | 对应的频道已存在 |
10406 | 不在频道内 |
10407 | 已经在频道内 |
10408 | 邀请不存在或已过期 |
10409 | 邀请已经拒绝 |
10410 | 邀请已经接受了 |
10417 | 加入频道uid 冲突 |
10419 | 频道人数超限 |
10420 | 已经在频道内(自己的其他端) |
提示:10201 、10202 比较特殊,使用时关注一下
此文档是否对你有帮助?
有帮助
我要吐槽