该接口支持邀请成员加入信令频道房间。房间内的所有人都能邀请他人进入房间。

发出邀请后，被邀请者会收到通知。

邀请方在邀请时可以配置是否向被邀请方发送推送消息，默认不推送。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求信息

请求 URL

httpsPOST https://api.yunxinapi.com/nimserver/signal/invite.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求头参数

请求 Header 的参数说明请参考 请求 Header。

请求体参数

参数名称	类型	是否必选	描述
channelId	String	是	信令频道 ID。
from	String	是	邀请者账号 ID。
to	String	是	被邀请者账号 ID。
requestId	String	是	邀请 ID。
attachExt	String	否	通知扩展字段，最大长度为 4096 字符。
needPush	Integer	否	是否推送。0（默认）：不推送；1：推送。
pushTitle	String	否	推送标题。长度最大为 32 字符。
pushContent	String	否	推送内容。长度最大为 500 字符。
pushPayload	String	否	推送 payload，JSON 格式，长度最大为 4096 字符。
needBadge	Integer	否	是否计入未读数。0：不计入；1（默认）：计入。
isSave	Integer	否	通知是否存离线消息，0（默认）：不存离线；1：存离线。
isRoute	Integer	否	是否抄送，0（默认）：不抄送；1：抄送。

请求示例

curlcurl -X POST -H "AppKey: go9dnk49***w0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb**cc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=ch_87654321&from=user_abc123&to=user_def456&requestId=invite_78901234' 'https://api.yunxinapi.com/nimserver/signal/invite.action'

响应示例

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明
code	Integer	状态码，200 表示请求成功。
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。

响应体示例

JSON{
  "code": 200,
  "data": {}
}

错误码

完整错误码请参考 错误码。