Blacklist
Endpoint for Social API
Note: Social API includes Appdata API, Blacklist API, People API, Profanity API, Leaderboard API, Remote Notification API.
Mobage Simplified Chinese Platform
| Production Social | http://sp.mobage-platform.cn/social/api/restful/v2 |
| Sandbox Social | http://sp.sb.mobage-platform.cn/social/api/restful/v2 |
Environment | URL |
|---|
Mobage Traditional Chinese Platform
Environment | URL |
|---|---|
| Production Social | http://sp.mobage-platform.tw/social/api/restful/v2 |
| Sandbox Social | http://sp.sb.mobage-platform.tw/social/api/restful/v2 |
Data Type Definition
Blacklist
| Name | Type | Description |
|---|---|---|
| id | UserId | A user who has added a targetId user to the blacklist |
| targetId | UserId | A user who has been added to the blacklist by an id user |
Description
This acquires a list of users who are specified in a blacklist.
URI Fragment
/blacklist/{userId}/{groupId}{-prefix|/|personId}
HTTP Method
GET
Supported Formats
JSON
Request Parameters
| Name | Type | Required/Optional | Parameter | Description |
|---|---|---|---|---|
| userId | UserId, Array | Required | URI Template Parameters | @me or direct value |
| groupId | GroupId | Required | URI Template Parameters. | Only @all is specifiable. |
| personId | UserId, Array | Optional | URI Template Parameters | direct value |
| fields | Array | Optional | Query String | the names defined in the data type Blacklist |
| format | String | Optional | Query String | Only json is specifiable |
| count | Number | Optional | Query String | An integer between 1 and 1000. The default value is 50. |
| startIndex | Number | Optional | Query String | An integer of 1 or greater |
| sortBy | String | Optional | Query String | Only targetId is specifiable. |
| sortOrder | String | Optional | Query String | ascending or 'descending' |
Request Body
N/A
Request Headers
Any request to the Mobage REST APIs must include the Authorization header. For more details, see How to add the Authorization Header .
Response Status Code
| HTTP Status Code | HTTP Status Message | Meaning |
|---|---|---|
| 200 | OK | Data successfully acquired |
| 400 | Bad Request | Corrupt request data on the client side |
| 401 | Unauthorized | Authorization error |
| 403 | Forbidden | The resource exists, but access is not possible due to a reason other than an authorization error. |
| 404 | Not Found | The resource doesn’t exist |
| 500 | Internal Server Error | An error on the API server side |
| 503 | Service Unavailable | The API cannot be used temporarily |
Response Body
Example 1. Require a List of Blacklisted Users
Example 2. A Blacklist Check between Two Parties
This code returns a 404 error if the user specified in personId is not registered in the blacklist.
1. build a string for OAuth parameters: firstly sort the following parameters alphabetically and URL encode the names and values, then join name and value with "=", finally join name/value pairs with " oauth_token is obtained from the token credential. 2. URL encode the following three parameters. 3. join the encoded parameters with "&". 1. Build a secret by joining the Consumer Secret and the Token Secret (obtained from the token credential) with " 2. Pass the base string and secret to the HMAC-SHA1 hashing algorithm. 3. the output of HMAC-SHA1 hashing algorithm is a binary string. Use base64 encode to produce the signature string. A tool is provided to verify whether your signature is correct. Refer to Oauth Signature Tool. Follow the steps to build the “Authorization” header: 1. URL encode the parameter names and values in the table below 2. Double quote the value, join name and value with "=", join name/value pairs with "," 3. Add realm parameter as an option 4. Add "OAuth " (including the space at the end) to the beginning of the header. oauth_token is obtained from the token credential. How to Add the Authorization Header
Step 1. Create the base string
&" Parameter Description Value oauth_consumer_keyThe Consumer Key for the application Issued when resist the application oauth_nonceUnique value for each request Generated on the game server oauth_signature_methodHash method Only HMAC-SHA1 is specifiableoauth_timestampUNIX timestamp Generated on the game server oauth_tokenThe token code oauth_versionOAuth version Only 1.0 Parameter Description Request Method HTTP Method to the API Server API URL URL to the API Server (exclude query parameters) OAuth Parameters A string Built in previous step Step 2. Generate the oauth_signature
&".Step 3. Build the Authorization Header
Parameter Value oauth_consumer_key Issued when resist the application oauth_nonce Generated on the game server oauth_signature Generated on the game server, Refer to Step 2. Generate the oauth_signature oauth_signature_method only "HMAC-SHA1" is specifiable oauth_timestamp Generated on the game server oauth_token oauth_version Only 1.0 Authorization Header Example