POST api/newmessage/{sessionID}

Send new message to guest (message parameters passed via POST)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionID

Session ID (obtained at login)

 string

Required

Body Parameters

NewMessage
NameDescriptionTypeAdditional information
CorrType

Correspondent type ("support", "admin", "user", "buyer", "visitor", "anonym")

 string

None.
CorrID

Correspondent ID

 integer

None.
Text

Message text

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CorrType": "sample string 1",
  "CorrID": 2,
  "Text": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample: 
<NewMessage>
  <corrType>sample string 1</corrType>
  <corrID>2</corrID>
  <text>sample string 3</text>
</NewMessage>

Response Information

Resource Description

NewMessageResponse
NameDescriptionTypeAdditional information
retval

Return code (0 - ok, otherwise - error)

 integer

None.
desc

Text description of the return code (error description)

 string

None.
id

Sent message ID

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "retval": 1,
  "desc": "sample string 2",
  "id": 3
}

application/xml, text/xml

Sample: 
<newmessage.response>
  <retval>1</retval>
  <desc>sample string 2</desc>
  <id>3</id>
</newmessage.response>