Escribir evento de personaje

Writes a character-based event into PlayStream.

Error codes

This operation may return the following PlayFab errors:

Error	Code
CharacterNotFound	1135
NoWritePermissionsForEvent	1207
ProductDisabledForTitle	1609

POST

Server

WriteCharacterEvent

Write Character Event

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/WriteCharacterEvent \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "3947655299CB786",
  "CharacterId": "E161CB4B7F6C34B",
  "EventName": "character_defeated_enemy",
  "Timestamp": "2016-03-07T00:00:00",
  "Body": {
    "Enemy": "guardian",
    "Damage": 5,
    "Coordinates": {
      "X": 123.4,
      "Y": 543.2
    }
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent"

payload = {
    "PlayFabId": "3947655299CB786",
    "CharacterId": "E161CB4B7F6C34B",
    "EventName": "character_defeated_enemy",
    "Timestamp": "2016-03-07T00:00:00",
    "Body": {
        "Enemy": "guardian",
        "Damage": 5,
        "Coordinates": {
            "X": 123.4,
            "Y": 543.2
        }
    }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '3947655299CB786',
    CharacterId: 'E161CB4B7F6C34B',
    EventName: 'character_defeated_enemy',
    Timestamp: '2016-03-07T00:00:00',
    Body: {Enemy: 'guardian', Damage: 5, Coordinates: {X: 123.4, Y: 543.2}}
  })
};

fetch('https://{titleId}.playfabapi.com/Server/WriteCharacterEvent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '3947655299CB786',
    'CharacterId' => 'E161CB4B7F6C34B',
    'EventName' => 'character_defeated_enemy',
    'Timestamp' => '2016-03-07T00:00:00',
    'Body' => [
        'Enemy' => 'guardian',
        'Damage' => 5,
        'Coordinates' => [
                'X' => 123.4,
                'Y' => 543.2
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Server/WriteCharacterEvent")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/WriteCharacterEvent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "EventId": "0f8fad5bd9cb469fa16570867728950e"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizaciones

X-SecretKey

string

header

requerido

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Cuerpo

application/json

This API is designed to write a multitude of different event types into PlayStream. It supports a flexible JSON schema, which allowsfor arbitrary key-value pairs to describe any character-based event. The created event will be locked to the authenticated title.

CharacterId

string

requerido

Unique PlayFab assigned ID for a specific character owned by a user

EventName

string

requerido

The name of the event, within the namespace scoped to the title. The naming convention is up to the caller, but it commonly follows the subject_verb_object pattern (e.g. player_logged_in).

PlayFabId

string

requerido

Unique PlayFab assigned ID of the user on whom the operation will be performed.

Body

object

Custom event properties. Each property consists of a name (string) and a value (JSON object).

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Timestamp

string

The time (in UTC) associated with this event. The value defaults to the current time.

Respuesta

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Ejemplo:

{
  "EventId": "0f8fad5bd9cb469fa16570867728950e"
}

Última modificación el 6 de octubre de 2026

Temas relacionados

Escribir evento de personaje Escribir evento de jugador Escribir evento de título Escribir eventos de telemetría Escribir eventos

⌘I

Write Character Event

curl --request POST \
  --url https://{titleId}.playfabapi.com/Server/WriteCharacterEvent \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "PlayFabId": "3947655299CB786",
  "CharacterId": "E161CB4B7F6C34B",
  "EventName": "character_defeated_enemy",
  "Timestamp": "2016-03-07T00:00:00",
  "Body": {
    "Enemy": "guardian",
    "Damage": 5,
    "Coordinates": {
      "X": 123.4,
      "Y": 543.2
    }
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent"

payload = {
    "PlayFabId": "3947655299CB786",
    "CharacterId": "E161CB4B7F6C34B",
    "EventName": "character_defeated_enemy",
    "Timestamp": "2016-03-07T00:00:00",
    "Body": {
        "Enemy": "guardian",
        "Damage": 5,
        "Coordinates": {
            "X": 123.4,
            "Y": 543.2
        }
    }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    PlayFabId: '3947655299CB786',
    CharacterId: 'E161CB4B7F6C34B',
    EventName: 'character_defeated_enemy',
    Timestamp: '2016-03-07T00:00:00',
    Body: {Enemy: 'guardian', Damage: 5, Coordinates: {X: 123.4, Y: 543.2}}
  })
};

fetch('https://{titleId}.playfabapi.com/Server/WriteCharacterEvent', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'PlayFabId' => '3947655299CB786',
    'CharacterId' => 'E161CB4B7F6C34B',
    'EventName' => 'character_defeated_enemy',
    'Timestamp' => '2016-03-07T00:00:00',
    'Body' => [
        'Enemy' => 'guardian',
        'Damage' => 5,
        'Coordinates' => [
                'X' => 123.4,
                'Y' => 543.2
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{titleId}.playfabapi.com/Server/WriteCharacterEvent"

	payload := strings.NewReader("{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Server/WriteCharacterEvent")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Server/WriteCharacterEvent")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"PlayFabId\": \"3947655299CB786\",\n  \"CharacterId\": \"E161CB4B7F6C34B\",\n  \"EventName\": \"character_defeated_enemy\",\n  \"Timestamp\": \"2016-03-07T00:00:00\",\n  \"Body\": {\n    \"Enemy\": \"guardian\",\n    \"Damage\": 5,\n    \"Coordinates\": {\n      \"X\": 123.4,\n      \"Y\": 543.2\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "EventId": "0f8fad5bd9cb469fa16570867728950e"
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Escribir evento de personaje

Error codes

Autorizaciones

Cuerpo

Respuesta