通过该接口向其他主播发起 PK 邀请、取消 PK 邀请、同意或拒绝其他主播的 PK 邀请。

接口请求地址

• 请求方法：POST
• URL：http://roomkit.netease.im/scene/apps/{appKey}/ent/pk/v1/inviteControl
• Content-Type：application/json;charset=utf-8

请求参数

• POST 请求中 Header 的设置请参考请求结构描述。
• POST 请求中 Body 的设置如下：

参数名称	类型	是否必选	示例	描述
pkId	String	可选	12345	PK ID。
anchorUserUuid	String	可选（当 action = 1 时必选）	1	被邀请参加 PK 的主播 ID。
action	Integer	必选	1	操作类型。 1：PK_INVITE（邀请） 2：PK_AGREE（同意） 3：PK_REFUSE（拒绝） 4：PK_CANCEL（取消） 5：PK_INVITE_TIME_OUT（PK 邀请超时）
pkRule	Object	可选	-	PK 规则。详细信息请参考 pkRule 结构。

返回参数

以下是返回结果中 data 属性内包含的参数。

参数	类型	示例	描述
pkId	String	202110191045129500060000	PK 邀请记录 ID。
rtcUid	Long	643535794139392	发起操作的主播 ID。
checkSum	String	5515dsfdsf****	PK 房间的校验码。
roomCid	String	6541651	PK 房间的 ID。
channelName	String	5445651	PK 房间的名称。

示例

请求 Body 示例

{
    "action":1,
    "anchorUserUuid": "267437774082561"
}

返回示例

{
    "code": 200,
    "data":{
        "pkId":"sss",
        "roomUid":"sss",
        "checkSum":"sss",
        "roomCid":"sss",
        "channelName":"sss"
    },
    "requestId": "af2d416202011101723237570050000",
    "costTime": "144ms"
}