MyChat Integration API: MCIAPI_CS_AddBBSMessage, place a message on the announcement board

MyChat Integration API: MCIAPI_CS_AddBBSMessage, place a message on the announcement board

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

ServerKey

string

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

APIStype

string

integration type. You can set any string;

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;

Sticky

boolean

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

Msg

string

message text.

 

Work result

{

 "Cmd"     : 0008,

 "UINFrom" : 0

}

 

Field

Type

Value

cmd

string

number of a command that was successfully executed;

UINFrom

integer

received unique identifier of a message sender (UIN).

 

Possible errors

1

2

3

 

Se also

0002:MCIAPI_CS_SendPrivateMessage

0004:MCIAPI_CS_SendChannelMessage