跳到主要内容

BlackList

概要​

在BlackList API 中,特定用户从已安装应用软件的用户中获取拉黑用户。

BlackList 对象字段​

向BlackList API 发送请求后,会反馈 BlackList 对象。

值说明类习惯型补充
idBlackList 持有人的 guidxs:string–
targetId被添加至BlackList 用户的 guidxs:string–

API请求​

HTTP 方法​

Authorization Code Grant

  • GET
    • 获取黑名单条目
    • 获取黑名单类集

Client Credentials Grant

  • 不支持

端点 URL​

  • Sandbox 环境

    https://sb-app.mobage.jp/social/api/restful/v2/blacklist/{guid}/{selector}{-prefix|/|pid}
  • 正式环境

    https://app.mobage.jp/social/api/restful/v2/blacklist/{guid}/{selector}{-prefix|/|pid}
guid​

在guid 参数中,指定下述任意一项的值。

值说明备注
@meviewer の guid必须
{guid}用户 ID必须

在guid 中指定有效用户 ID时 ,需用户已安装此应用软件。

selector​

selector 参数中,指定下述任意一项的值。

值说明备注
@all表示被guid 参数所指定的用户登陆在黑名单中,且已安装了当前应用软件的用户的 BlackList 类集资源必须
pid​

selector 为 @all 时,可指定pid 参数。

值说明备注
{guid}被guid 参数所指定的用户登录在黑名单中的用户的 guid任意

指定pid 参数并试图获取条目资源时,如果反馈 200 OK ,则表示已被拉黑。如果反馈404 Not Found ,则是未被拉黑的用户。

查询参数​

可指定下述查询参数。

format​

可指定响应格式。

值说明备注
json"application/json; charset=utf8"任意、默认值

fields​

可指定想要获取的属性信息。关于可指定的字段名,请参见 BlackList 对象字段。
要指定多个时,使用不带空格的逗号 (,) 分隔指定。
省略fields 参数时,获取下述全部属性信息。

为提高性能,请尽量只获取必要的属性。

count​

获取类集资源的响应时,可指定最多可获取的条目资源条数。
默认值为 50 条,最多可指定1000条。

startIndex​

指定类集资源的开始值。省略时,自动指定 1 (最小值)。

API响应​

响应代码​

API 的响应代码为以下中的任意一项。

请求 HTTP 方法响应代码响应信息说明
GET200OK数据获取正常完成
GET400Bad Request请求数据不当
GET401UnauthorizedOAuth 验证失败
GET403Forbidden未安装应用软件的用户
GET404Not Found未被拉黑的用户
GET500Internal Server ErrorAPI 端的问题导致失败

注意事项​

  • 在guid 中指定 @me 以外时,需要guid 的用户已安装此应用软件。
  • 在guid 中指定数值以外的值时,响应代码反馈 400。
  • 用户未安装此应用软件时,响应代码反馈 403。

样例​

获取viewer 已注册的 BlackList 类集​

请求格式​

GET /social/api/restful/v2/blacklist/@me/@all?format=json&fields=id,targetId&count=10&startIndex=1

响应格式​

200 OK
{
"entry": [
{
"targetId":"sb.mbga.jp:10032",
"id":"sb.mbga.jp:10028"
},
{
"targetId":"sb.mbga.jp:10033",
"id":"sb.mbga.jp:10028"
},
{
"targetId":"sb.mbga.jp:10039",
"id":"sb.mbga.jp:10028"
}
],
"startIndex":1,
"sorted":false,
"itemsPerPage":10,
"totalResults":3,
"filtered":true
}
 

更新履历​

  • 2015/12/24
    • 修改BlackList 对象字段。
    • 修改样例中的请求格式、响应格式。