Place a message on the announcement board.

 

Syntax


0008 MCIAPI_CS_AddBBSMessage
{
 "ServerKey" : "iddqd",
 "APIStype"  : "mydata",
 
 "UserFrom"  : "user@mycompany.com",
 "Expired"   : "10.09.2016.17.34.15",
 "Sticky"    : false,
 "Msg"       : "bla-bla-bla"
}


Parameters

Parameter

Type

Value

cmd

string

"0008", MCIAPI_CS_AddBBSMessage command number

ServerKey

string

Integration API key, can be set in the server settings;

APIStype

string

integration type. You can set any string;

context

string

optional parameter, any text that returns in a response command;

UserFrom

string

user-sender. "0" by default. You can set UIN, email, or a user nickname. A user must be real. If you skip this parameter, the sender will be set as the built-in bot with UIN = 0;

Expired

string

announcement date/time relevance in the format "dd.mm.yyyy.hh.nn.ss". If you skip this parameter, date relevance will be set as the last second of the current day. After this time an announcement will be automatically transferred to an archive; time specified in UTC;

Sticky

boolean

make "pinned" announcement (place it on top). Has "true" or"false" values;

Msg

string

message text.

 

Work result


{
 "Cmd"     : 0008,
 "UINFrom" : 0
 "Expired" : "19.07.2023.23.59.59"
}


Field

Type

Value

cmd

string

number of a command that was successfully executed;

context

string

any text sent to the server in a query command;

UINFrom

integer

received unique identifier of a message sender (UIN);

Expired

string

announcement expiration date/time in format dd.mm.yyyy.hh.nn.ss (UTC).

 

Possible errors

#4, MCIAPI_Error_EmptyMessage

#5, MCIAPI_Error_WrongIntegrationKey

#9, MCIAPI_Error_API_Disabled

#21, MCIAPI_Error_WrongData

#42, MCIAPI_Error_UnknownUser

#43, MCIAPI_Error_UnknownDomainUser

 

See also

0002: MCIAPI_CS_SendPrivateMessage

0004: MCIAPI_CS_SendChannelMessage