该接口支持取消邀请成员加入信令房间。

取消后，被邀请的用户会收到取消邀请的通知。

只能取消自己发出的邀请，无法影响房间内其他用户发出的邀请。

调用频率

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

请求信息

请求 URL

POST https://{endpoint}/im/v2/signalling_room/actions/cancel_invite

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

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

请求体参数

参数名称	类型	是否必选	示例	说明
channel_id	String	是	"ash1jw1kw"	信令房间 ID。
inviter_account_id	String	是	"zhangsan"	操作者（邀请者）账号 ID，必须为信令房间的创建者或者信令房间成员。
invitee_account_id	String	是	"lisi"	被邀请者账号 ID。
request_id	String	是	"aqwhsqwj11"	邀请 ID，长度上限 128 个字符。
server_extension	String	否	{"k":"v"}	通知时的扩展字段，最长 4096 个字符。
- route_config	Object	否	-	抄送配置项。
route_enabled	Boolean	否	false	是否抄送，false（默认）：不抄送；true：抄送。
offline_enabled	Boolean	否	false	通知是否存离线，false（默认）：不存；true：存离线。
unread_enabled	Boolean	否	false	是否计入未读数，true（默认）计入；false：不计入。
- push_config	Object	否	-	推送配置项。
push_enabled	Boolean	否	false	是否推送。false（默认）：不推送；true：推送。
push_title	String	否	"张三"	推送标题，长度上限 32 个字符。
push_content	String	否	"取消音视频邀请"	推送文案，长度上限 500 个字符。
push_payload	String	否	-	推送对应的 payload，必须是 JSON 格式，长度上限 4096 个字符。

请求体示例

JSON{
    "channel_id": "xxx",
    "operator_account_id": "zhangsan",
    "target_account_id": "lisi",
    "request_id": "xxxx",
    "server_extension": "xxx"
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	业务状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

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

错误码

本文仅列举部分业务接口错误码，完整列表请参考 错误码。

错误码	错误信息	说明	处理建议
200	请求成功	success	-
414	参数错误	Invalid parameter:channel_id	检查参数是否符合命名规范
102426	用户被拉黑	account in block list.	-
118410	信令服务未开通	The signaling service is disabled. Please enable it first.	请提前开通信令服务
118404	信令房间不存在	The signaling room does not exist.	请先创建信令房间
118310	邀请不存在	The signaling invitation does not exist.	-
118302	邀请已被接受	The signaling invitation has been accepted.	-
118307	邀请已被拒绝	The signaling invitation has been declined.	-
500	服务器内部错误	internal server error	-