Endpoint description

Send a message to the specified player

Endpoint route

POST

/api/sendmessage

Response type

Application/Json

Header parameters

KeyValueTypeRequired
AuthorizationBasic [key]stringFor Basic authentication mode only
Authorization[key]stringFor Key-Basic and Key-Advanced authentication modes only

Query Parameters

No parameters

Body parameters

    
{
    "message": string,
    "player": string            // - Optionnal, if ommited, sends a message to everyone
}

Access rights

Authentication typeKey typeAllowed
Openfalse
Basicfalse
Key-Basicfalse
Key-AdvancedPublic keyfalse
Key-AdvancedProtected keyfalse
Key-AdvancedAdmin keyfalse

Success response

{
    "success": bool,
    "code": int,
    "message": string
}

Error response

{
    "success": bool,
    "code": int,
    "message": string
}

Return codes

HTTP CodeType
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found