3.3 Logout (登出玩家)

Description (说明)

Invoke this API to force logout an online player.
调用此API以强制登出玩家。

URL (网址)

https://{host}/api/logout

Request Method

POST

Request Parameters (请求参数)

Field (栏位)	Type (型态)	Required (必要)	Description (说明)
agentId	String	Y	Agent ID <= 50 characters 代理帐号
userIds	Array of String	Y	Array of User ID array size <= 100 欲登出玩家帐号阵列 v24.9.1 update

{
  "userIds": [
    "hrgpl0001"
  ]
}

Return Result (返回结果)

Field (栏位)	Type (型态)	Description (说明)
code	String	Status Code fixed 4 characters 状态码 Please refer to 5.4 Status Code for details. 详情请参考 5.4 状态代码
data	Object
agentId	String	Agent ID <= 50 characters 代理帐号
userIds	Array of String	Contains all usernames that are force logout 包含强制登出的所有玩家用户名
successCount	Number	Total number of players force logout success by this call 强制登出成功的玩家总数
failureCount	Number	Total number of players force logout failure by this call 强制登出失败的玩家总数

{
  "code": "0000",
  "data": {
    "agentId": "hrgag",
    "userIds": [
      "hrgpl0001"
    ],
    "successCount": 1,
    "failureCount": 0
  }
}

Sample Request For Each Language (各语言请求范例)

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"userIds\":[\"hrgpl0001\"]}");
Request request = new Request.Builder()
  .url("https://{host}/api/logout")
  .method("POST", body)
  .addHeader("Authorization", "Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

var client = new RestClient("https://{host}/api/logout");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1");
request.AddHeader("Content-Type", "application/json");
var body = @"{\"userIds\":[\"hrgpl0001\"]}";
request.AddParameter("application/json", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

var myHeaders = new Headers();
myHeaders.append("Authorization", "Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1");
myHeaders.append("Content-Type", "application/json");

var raw = "{\"userIds\":[\"hrgpl0001\"]}";

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("https://{host}/api/logout", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import http.client
import json

conn = http.client.HTTPSConnection("{host}")
payload = "{\"userIds\":[\"hrgpl0001\"]}"
headers = {
  'Authorization': 'Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1',
  'Content-Type': 'application/json'
}
conn.request("POST", "https://{host}/api/logout", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://{host}/api/logout"
  method := "POST"

  payload := "{\"userIds\":[\"hrgpl0001\"]}"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1")
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{host}/api/logout');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Basic TWpNQ0JSM1NFYnBrYXdSNTpNak1DQlIzU0VicGthd1I1',
  'Content-Type' => 'application/json'
));
$request->setBody("{\"userIds\":[\"hrgpl0001\"]}");
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}