创建邀请者

更新时间：2022-11-14 18:23:35

接口描述

1、邀请海报-创建邀请者
2、appId、timestamp、sign必须通过url传递
3、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/invite/poster/create

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、观看页链接访问方式：https://live.polyv.cn/watch/{channelId}?invitePosterId={invitePosterId} 例如：https://live.polyv.cn/watch/3121680?invitePosterId=4fdb2496，受邀用户在微信访问该链接即可完成邀请绑定，邀请明细数据可通过“查询邀请海报明细数据”接口得到

请求参数描述

参数名	必选	类型	说明
appId	true	String	账号appId【详见获取密钥】
timestamp	true	Long	当前13位毫秒级时间戳，3分钟内有效
sign	true	String	签名，为32位大写的MD5值，仅query参数参与签名【详见签名生成规则】
channelId	true	String	频道号
openId	true	String	邀请者用户ID
nickname	true	String	邀请者昵称
avatar	false	String	邀请者头像url地址，如果为空，则使用默认头像
viewerId	false	String	邀请者观众ID
invitee	false	String	自定义邀请ID

示例

http://api.polyv.net/live/v4/channel/invite/poster/create?appId=frlr1zazn3&timestamp=1653556311000&channelId=3121680&sign=959D476D141DC170E0118DCC43839101&openId=jiangyifana&nickname=%E5%B8%86%E7%83%A6%E5%8F%8D%E9%A5%AD

响应参数描述

参数名	类型	说明
code	Integer	状态码，与 http 状态码相同，用于确定基本的响应状态
status	String	响应结果，由业务决定，成功返回success，失败返回error
success	Boolean	是否成功响应
requestId	String	请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error	Object	状态码非200时的错误信息【详见Error字段描述】
data	Object	【详见data字段说明】

Error参数描述

参数名	类型	说明
code	Integer	错误代码，用于确定具体的错误原因
desc	String	错误描述，与 error.code 对应

data参数描述

参数名	类型	说明
invitePosterId	String	邀请海报ID
channelId	Integer	频道ID
openId	String	邀请者用户ID
invitee	String	自定义邀请ID

Java请求示例

快速接入基础代码请下载相关依赖源码，点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 创建邀请者
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void inviterCreateTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/channel/invite/poster/create";
    String channelId = "3121680";
    String openId = "1yexRmHZoJrcw40";
    String nickname = "张三";
    String viewerId = "UPpuW43RFIKSveD";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("openId", openId);
    requestMap.put("nickname", nickname);
    requestMap.put("viewerId", viewerId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    
    log.info("测试创建邀请者成功：{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "2a8712050df1475db89fbb9348efc035.65.16541338429926329",
    "data": {
        "invitePosterId": "2325308f",
        "channelId": 3121680,
        "openId": "1yexRmHZoJrcw40",
        "invitee": null
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

直播服务端 API