|
Request Parameters
Parameter
|
Description
|
Mandatory
|
id
|
Station identifier
|
yes
|
message
|
Text of a message sent to the station.
Message text may contain the {link} macro
|
yes
|
logo
|
Logo in BMP format (24-bit image in the base64 encoding)
|
no
|
logo-text
|
Text placed to left of the logo, for example, a company name
|
no
|
logo-url
|
Logo URL opened when the logo is clicked
|
no
|
link-text
|
The {link} macro will be substituted with a string defined in this parameter
|
no
|
link-url
|
Page URL opened when the {link} is clicked
|
no
|
Request Example
http://192.168.1.1:9080/api/stations/send-message.ds?id=1&message=message&logo-text=logo-text&logo-url=www.drweb.com&link-text=drweb&link-url=drweb.com&logo={base64}
Response Documents Structure
•XML response. •JSON response. XML Response Structure
<drweb-avdesk-api api_version="4.1.3" timestamp="1392276843" server="192.168.1.1" srv_version="10.01.0.201707130" status="true">
<stations total="2">
<station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="initiated"/>
<station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="delayed"/>
</stations>
</drweb-avdesk-api>
|
Description of XML Response Parameters
•The <stations /> element contains information about all stations to which the message has been sent. The <stations /> element attributes:
Attribute
|
Description
|
total
|
Total number of stations
|
▫The <station /> element contains information about a specific station to which the message has been sent. The <station /> element attributes:
Attribute
|
Description
|
id
|
Station identifier
|
status
|
The state of message sending process. May take the following values:
•delayed—send is delayed, •failed—send is failed, •initiated—send is initiated. |
JSON Response Structure
{ "head": {
"status": true,
"timestamp":1392276920,
"api":{
"version":40103},
"server":{
"name":"192.168.1.1",
"version":1000201707130,
"uuid": "a509dab1-d423-4059-971a-aa3944a2c48a"}},
"data":{
"total": 0,
"list": [ {
"id": "d071625c-d21d-b211-9bc4-bc02713bf843",
"status": "initiated"
} , {
"id": "7",
"status": "delayed"
}]}}
|
Description of JSON Response Parameters
The data block contains information on all stations to which the message has been sent.
The data block elements:
Field name
|
Description
|
total
|
Total number of stations to which the message has been sent
|
•The list array contains information about specific stations to which the message has been sent. Elements in the list array:
Field name
|
Description
|
id
|
Station identifier
|
status
|
The state of message sending process. May take the following values:
•delayed—send is delayed, •failed—send is failed, •initiated—send is initiated. |
|
