whisper

Send a private message.

Addressed by in-game name rather than by account id — the name a player shows in the channel roster.

In Trading.

Request

POST /api/v1/sessions/{accountKey}/actions/whisper

Parameters

NameTypeRequiredDescription
nicknamestringyesWho to send it to.
textstringyesThe message.

Example request

{ "nickname": "Eve", "text": "Still have the boots?" }

Response

`{ ok, target, text }`.

FieldTypeMeaning
targetstringThe `nickname` the message was addressed to, echoed back.

Example response

{ "ok": true, "target": "Eve", "text": "Still have the boots?" }

Errors

CodeWhen
action_failedNot in a channel.
plan_limitNot on the free plan.

See also

DarkerAPI is an independent project. It is not affiliated with, endorsed by or associated with IRONMACE Co., Ltd. or Valve Corporation. “Dark and Darker” and related marks belong to their respective owners.