| (13 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
Embedded web server provides several services such as: | Embedded web server provides several services such as: | ||
| − | * '''status''' - represent some method of [[ | + | * '''status''' - represent some method of [[API/Status|Status API]] |
* '''service''' - implements several methods to send SMS and telemetry or make a call with AMBE file | * '''service''' - implements several methods to send SMS and telemetry or make a call with AMBE file | ||
* '''health''' - monitoring of embedded components compatible with [https://www.consul.io/api/health.html Consul Health API] | * '''health''' - monitoring of embedded components compatible with [https://www.consul.io/api/health.html Consul Health API] | ||
| Line 8: | Line 8: | ||
= Detection of entry point = | = Detection of entry point = | ||
| − | ''system.php'' | + | ''system.php'' and ''remote.php'' at [[API/Status|Status API]] provide a data of entry point for HTTP API. Please check ''"remote"'' object. ''Port'' parameter corresponds to TCP port and ‘'Secure'’ indicates using of HTTPS (or HTTP). |
= Status API = | = Status API = | ||
| Line 22: | Line 22: | ||
''.json'' methods implement fully the same structure of data as ''.php'' version. | ''.json'' methods implement fully the same structure of data as ''.php'' version. | ||
''.msgpack'' methods have MeasagePack-encoded data in the same order as ''.json'' version. | ''.msgpack'' methods have MeasagePack-encoded data in the same order as ''.json'' version. | ||
| − | Please check info about General Status API (''.php'') at [[API/Status]]. | + | Please check info about General Status API (''.php'') at [[API/Status|Status API]]. |
This API supports zlib compression requested by ''Accept-Encoding: deflate''. | This API supports zlib compression requested by ''Accept-Encoding: deflate''. | ||
| Line 31: | Line 31: | ||
In case of success server returns HTTP code 200 or 500 in case of failure. | In case of success server returns HTTP code 200 or 500 in case of failure. | ||
| − | == /service/call == | + | == /service/call - play voice call == |
'''source''' - ID to be used as a source<br> | '''source''' - ID to be used as a source<br> | ||
'''destination''' - ID of destination station or group<br> | '''destination''' - ID of destination station or group<br> | ||
| − | '''type''' - ''private'' or ''announce'' (for group | + | '''type''' - ''private'' or ''announce'' (for a group call)<br> |
| − | '''data''' - attached file in plain format of AMBE mode 33 | + | '''data''' - attached file in plain format of AMBE mode 33 (.ambe) or DSD (.amb) |
| − | == /service/message == | + | == /service/message - send text message == |
'''source''' - ID to be used as a source<br> | '''source''' - ID to be used as a source<br> | ||
| Line 47: | Line 47: | ||
Long-polling mode responds to get a status of message delivery (check section '''Long-polling'''): | Long-polling mode responds to get a status of message delivery (check section '''Long-polling'''): | ||
| − | * '' | + | * ''{ "status": 8 }'' - Success |
| − | * '' | + | * ''{ "status": 64 }'' and greater - some kind of delivery error |
== /service/telemetry - set state == | == /service/telemetry - set state == | ||
| Line 78: | Line 78: | ||
In case of long-polling mode, the API will always answer with HTTP code 200, and then slowly transmit response: | In case of long-polling mode, the API will always answer with HTTP code 200, and then slowly transmit response: | ||
* Keep-alive chunks - space character | * Keep-alive chunks - space character | ||
| − | * Final message: | + | * Final message (JSON): |
| − | ** ''' | + | ** '''{ "result": "success" }''' |
| − | ** ''' | + | ** '''{ "result": "failure" }''' |
| − | ** ''' | + | ** '''{ "status":''' ''xxx'' '''}''' - in case of simple numeric answer, such as SMS delivery report |
| − | ** ''' | + | ** '''{''' ''xxx'' '''}''' - in case of complex content |
= Health API = | = Health API = | ||
Since version BrandMeister 20190421-185653 has built-in web server.
Embedded web server provides several services such as:
system.php and remote.php at Status API provide a data of entry point for HTTP API. Please check "remote" object. Port parameter corresponds to TCP port and ‘'Secure'’ indicates using of HTTPS (or HTTP).
.json methods implement fully the same structure of data as .php version. .msgpack methods have MeasagePack-encoded data in the same order as .json version. Please check info about General Status API (.php) at Status API. This API supports zlib compression requested by Accept-Encoding: deflate.
This service API requires to use HTTP Digest Authentication, where username is an registered application ID. All requests should be sent as HTTP POST method having type application/x-www-form-urlencoded or application/form-data In case of success server returns HTTP code 200 or 500 in case of failure.
source - ID to be used as a source
destination - ID of destination station or group
type - private or announce (for a group call)
data - attached file in plain format of AMBE mode 33 (.ambe) or DSD (.amb)
source - ID to be used as a source
destination - ID of destination station or group
type - private or announce (for group message)
text - message text in UTF-8
interval - long-poll timeout in milliseconds (optional)
Long-polling mode responds to get a status of message delivery (check section Long-polling):
source - ID to be used as a source
destination - ID of destination station or group
output1 ... output8 - command for each output (same as MQTT API): 0 = None, 20 = Clear, 21 = Set, 22 = Toggle, 23 = Pulse
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
In case of long-polling mode, the API will always answer with HTTP code 200, and then slowly transmit response:
Objects list is available via system.php and D-BUS API.
Health check compatible with Consul:
Detailed metric information in JSON format
Since version BrandMeister 20190421-185653 has built-in web server.
Embedded web server provides several services such as:
system.php provides a data of entry point of HTTP interface. Please check "remote" object, returned by system.php. Port parameter corresponds to TCP port and ‘'Secure'’ indicates using of HTTPS (or HTTP).
.json methods implement fully the same structure of data as .php version. .msgpack methods have MeasagePack-encoded data in the same order as .json version. Please check info about General Status API (.php) at API/Status. This API supports zlib compression requested by Accept-Encoding: deflate.
This service API requires to use HTTP Digest Authentication, where username is an registered application ID. All requests should be sent as HTTP POST method having type application/x-www-form-urlencoded or application/form-data In case of success server returns HTTP code 200 or 500 in case of failure.
source - ID to be used as a source
destination - ID of destination station or group
type - private or announce (for group message)
data - attached file in plain format of AMBE mode 33
source - ID to be used as a source
destination - ID of destination station or group
type - private or announce (for group message)
text - message text in UTF-8
interval - long-poll timeout in milliseconds (optional)
Long-polling mode responds to get a status of message delivery (check section Long-polling):
source - ID to be used as a source
destination - ID of destination station or group
output1 ... output8 - command for each output (same as MQTT API): 0 = None, 20 = Clear, 21 = Set, 22 = Toggle, 23 = Pulse
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
source - ID to be used as a source
destination - ID of destination station or group
interval - long-poll timeout in milliseconds
In case of long-polling mode, the API will always answer with HTTP code 200, and then slowly transmit response:
Objects list is available via system.php and D-BUS API.
Health check compatible with Consul:
Detailed metric information in JSON format
BrandMeister