UA 好友列表

此页面描述了通过用户获取实现 CPI 的邀请用户和被邀请用户的信息(VIDPlayerID)。使用以下数据编写每个用户的好友列表。

  • 请求 URL
    常见 URL https://promotion.qpyou.cn/ua/user/invitee
    沙盒 URL https://sandbox-promotion.qpyou.cn/ua/user/invitee
    HTTP 方法 POST
    内容类型 text/html
    数据格式 JSON
  • 标题
    字段名称 描述 类型 是否必填
    授权 通过Bearer授权的CertificationKey有效 字符串
  • 标题
    字段名称 描述 类型 必需
    授权 通过Bearer授权的CertificationKey有效 字符串
  • 请求
    字段名称 描述 类型 必需
    game_index 在 AppCenter 中注册的游戏索引。 整数
    begin_id 朋友列表通过 CPI 开始的第一个 ID。(如果请求是第一次,则值为 0) 整数
    data_limit 一次导入的朋友列表数量。如果未输入,默认值为 1000。 整数
    sender_vid 邀请用户的 VID,PlayerID。 字符串
  • 响应
    字段名称 描述 类型 必需
    result_code 响应代码 0: 验证成功 其他: 验证失败 整数
    result_message 响应消息 字符串
    request 请求时接收到的API实现数据。 (发送请求数据) 数组
    ㄴ game_index 在AppCenter中注册的游戏索引。 整数
    ㄴ begin_id 朋友列表通过CPI开始的第一个ID。 (如果请求是第一次,则值为0) 整数
    ㄴ data_limit 一次导入的朋友列表数量。 如果未输入,则默认值为1000。 整数
    ㄴ sender_vid 邀请用户的VID,PlayerID。 字符串
    result 朋友列表。 当不存在时可为null。 数组
    ㄴ companion_id 在HIVE中内部管理的ID。 字符串
    ㄴ sender_vid 邀请用户的VID,PlayerID。 字符串
    ㄴ receiver_vid 被邀请用户的VID,PlayerID。 字符串
    ㄴ dateadd 当两个用户成为朋友时。 字符串(日期时间)
    ㄴ id 当前数据的唯一ID。 (请求下一个数据时可用) 字符串
    result_count 结果数量。 整数
    last_id 传输的朋友列表中的最后唯一ID。 (请求下一个数据时可用) 整数
  • 结果 代码 <
    代码 消息 描述
    0 成功 数据传输成功
    201 无效参数当传输的参数错误或不存在(必填值为空)。 当传输格式不是POST时。
  • 调用示例
    curl -L -v
    -d '{"game_index": 539, "begin_id": 0, "data_limit": 3, "sender_vid": 21001}'
    -H "Content-Type: application/json"
    https://sandbox-promotion.qpyou.cn/ua/user/invitee
    
  • 请求 示例
    POST /ua/user/invitee HTTP/1.1
    > User-Agent: curl/7.29.0
    > Host: sandbox-promotion.qpyou.cn
    > Accept: /
    > Content-Type: application/json
    > Content-Length: 72
    
  • Response 示例
    < HTTP/1.1 200 OK
    < Server: nginx
    < Date: Tue, 15 Mar 2022 03:26:19 GMT
    < Content-Type: application/json
    {"result_code":0,"result_message":"success","request":{"game_index":539,"begin_id":0,"data_limit":3,"sender_vid":21001},"result":[],"result_count":0,"last_id":0}