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

Mobage Traditional Chinese Platform

Data Type Definition

Blacklist

NameTypeDescription
idUserIdA user who has added a targetId user to the blacklist
targetIdUserIdA 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

NameTypeRequired/OptionalParameterDescription
userIdUserId, ArrayRequiredURI Template Parameters@me or direct value
groupIdGroupIdRequiredURI Template Parameters.Only @all is specifiable.
personIdUserId, ArrayOptionalURI Template Parametersdirect value
fieldsArrayOptionalQuery Stringthe names defined in the data type Blacklist
formatStringOptionalQuery StringOnly json is specifiable
countNumberOptionalQuery StringAn integer between 1 and 1000. The default value is 50.
startIndexNumberOptionalQuery StringAn integer of 1 or greater
sortByStringOptionalQuery StringOnly targetId is specifiable.
sortOrderStringOptionalQuery Stringascending 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 CodeHTTP Status MessageMeaning
200OKData successfully acquired
400Bad RequestCorrupt request data on the client side
401UnauthorizedAuthorization error
403ForbiddenThe resource exists, but access is not possible due to a reason other than an authorization error.
404Not FoundThe resource doesn’t exist
500Internal Server ErrorAn error on the API server side
503Service UnavailableThe API cannot be used temporarily

 

Response Body

Example 1. Require a List of Blacklisted Users

HTTP Request
HTTP Response

Example 2. A Blacklist Check between Two Parties

HTTP Request
HTTP Response

This code returns a 404 error if the user specified in personId is not registered in the blacklist.

HTTP Response

How to Add the Authorization Header

Step 1. Create the base string

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 "&" 

ParameterDescriptionValue
oauth_consumer_keyThe Consumer Key for the applicationIssued when resist the application
oauth_nonceUnique value for each requestGenerated on the game server
oauth_signature_methodHash methodOnly HMAC-SHA1 is specifiable
oauth_timestampUNIX timestampGenerated on the game server
oauth_tokenThe token code

oauth_token is obtained from the token credential.

oauth_versionOAuth versionOnly 1.0

2. URL encode the following three parameters.

ParameterDescription
Request MethodHTTP Method to the API Server
API URLURL to the API Server (exclude query parameters)
OAuth ParametersA string Built in previous step

3. join the encoded parameters with "&".

Step 2. Generate the oauth_signature

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

Step 3. Build the Authorization Header

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.

ParameterValue
oauth_consumer_keyIssued when resist the application
oauth_nonceGenerated on the game server
oauth_signatureGenerated on the game server, Refer to Step 2. Generate the oauth_signature
oauth_signature_methodonly "HMAC-SHA1" is specifiable
oauth_timestampGenerated on the game server
oauth_token

oauth_token is obtained from the token credential.

oauth_versionOnly 1.0
Authorization Header Example

 

 

PREVIOUS

Appdata

NEXT

Profanity