Detailed explanation of smart speaker docking gateway API

1Interface Return Parameter Description

Fixed format of return parameters: code = 200 indicates successful operation, msg indicates operation message prompt, and data returns specific data generic type, depending on the specific interface. If the returned data is just a prompt and no operation is performed, subsequent interfaces will not provide any description of the data.

Request: Host IP address + port 6521 + object's request method name + parameters

For examplehttp://192.168.1.106:6521/login?body={"acc":"admin","pwd":"admin","host":"192.168.1.200","port":"4196"}

Description: POST has only one request parameter, body. Specific data is placed in the body in JSON format.

Among them, acc (username) and pwd (password) are required parameters, and subsequent interfaces will not provide any further description, except for interfaces that do not require them unless specifically stated. All POST interfaces must include the username and password.

2 HTTPInterface Description

When adding a GT, you need to provide username, password, GTIP, and GT port

2Interface (15-26 are music interfaces)

1Login Interface

Method Name: login

Parameters: acc (username), pwd (password), host (intranet address), port (intranet port)

Example:http://192.168.1.106:6521/login?body={"acc": "admin", "pwd": "admin", "host": "192.168.1.200", "port": "4196"}

Description: POST only has one request parameter, body. The specific data is all in the body in JSON format.

Among them, acc (username) and pwd (password) are required parameters. They will not be further explained in subsequent interfaces, except for interfaces that are not specifically stated to not require them. All POST interfaces must include the username and password.

2 VoiceVoice Synthesis Settings

Method Name: setVoice

Parameters: soundType; // Sound Type: 0--Normal Female Voice, 1--Normal Male Voice, 2--Special Male Voice, 3--Emotional Male Voice

speed; // speech rate 1-9 list key list isKeyBroadcase whether to filter

3queryVoice configuration

method name queryVoice

parameters

return value soundType returned in data; // sound type 0--normal female voice, 1--normal male voice, 2--special male voice, 3--emotional male voice 1-9 speed; // speech rate 1-9, list key list isKeyBroadcase whether to filter

4modify username and password

method modifyUser

parameters newAcc username newPwd password

5 set city weather region code

Method setCity

Parameters cityCode // region code city province/city zone region

6 Query city weather region code

Method queryCity

Parameters

Return cityCode // region code city province/city zone region

7 Query voice advanced configuration list

Method queryAdvancedVoice

Parameters

Return data [{“key”:”key”,”content”:”content”}]

8 Save voice configuration list

Method saveAdvancedVoice

Parameter settings [{“key”:”key”,”content”:”content”}]

9 QueryPM25Settings

Method queryPM25

Parameter isOutdoor (indicating whether it's indoors or outdoors)

Returns {“isBeeQual”: false, “isData”: false, “isFive”: false, “isFour”: false, “isGreaterThanEqual”: false, “isLessThanEqual”: false, “isLoop”: false, “isLoopTime”: 0, “isNumberJudge”: false, “isOne”: false, “isOutdoor”: false, “isRepeat”: false, “isSection”: false, “isSeven”: false, “isSix”: false, “isTextDriven”: false, “isTextDrivenTTS”: false, “isThree”: false, “isTimingQuery”: false, “isTow”: false, “oneV”: 0, “twoV”: 0}

10 SavePM25Settings

Method savePM25

Parameters: same as the query return value

11 Query Index  

Method queryIndex

Parameter indexData Index Content  address Indoor Weather Address Mandatory when adding an indoor location

Return   {"CharacterJudgment": "Without Umbrella", "data": "aabbccdd", "indexData": "Umbrella Index", "isData": true, "isFive": true, "isFour": true, "isOne": true, "isRepeat": true, "isSeven": true, "isSix": true, "isTextDriven": true, "isTextDrivenTTS": true, "isThree": true, "isTimingQuery": true, "isTow": true, "textDrivenContent": "Master Bedroom Closed"}

12 Save Index

Method saveIndex

Parameter Query Method Return Content

13 Query Sunrise and Sunset

Method querySunriseAndSunset

Parameter

Return {"isSunrise": true, "isSunset": true, "sunriseData": "ccddbbee", "sunset": "112233aa"}

14 Save sunrise and sunset

Method: saveSunriseAndSunset

Parameters: same as query method

15 Music control

Method: musicControl

Parameters: control (previous, next, play, pause, down classify, up classify, down dimension, up dimension, add to favorites, remove from favorites, play favorites, all loop, shuffle, single loop)

Example

http://192.168.1.106:6521/musicControl?body={"acc": "admin", "pwd": "admin", "control": "previous"}

16 Get big classify

Method: getBigClassify

Parameters

17 Get Latitude

Method: getMiniClassify

Parameter:daleibieid (Big Category ID)

18 Get Favorite Music List

Method: getMusicColl

Parameter:

19 Delete Favorite Music

Method: deleteCollHandler

Parameter: id (Favorite Music ID)

20 Play Specified Favorite

Method: payMusiColl

Parameter: id (Homepage Music ID)

21 Set custom text collection to drive music

Method: setingCustomMusic

Parameter: id (collection music ID) text (drive text)

22 Set custom drive categorization

Method: setingCustomCategorise

Parameter: id (categorization ID) text (drive text)

23 Get all latitudes

Method: getAllMiniClassfly

Parameter

Based on the obtained controlcode, it can be controlled through the musiccontrol method

http://192.168.1.106:6521/musicControl?body={"acc":"admin","pwd":"admin","control":"2A000001"}

24 Search for music

Method: searchMusic

Parameter: name - the name of the music to search for

25 Play specified music

Method: payMusic

Parameter: id - the ID of the music to play

26 Get current playing music information

Method: getPayMusicInfo

Parameters:

27 Get all phone probe list

Method: getAllProbePhone

Parameters:

28 Add or modify the phone detection

method `addProbePhone`

Parameters: `id` (detector ID) (newly added: not required; modified: required), `name` (name), `startTime` (start time), `endTime` (end time), `goHomeMsg` (home voice), `levaeHomeMsg` (away voice), `goHomeData` (home execution command), `levaeHomeData` (away execution command). Note for custom protocols: all custom protocols must be prefixed with a `+` sign, for example, `+AABBCCDD`.

29 Send the home protocol

method `recordProbe`

Parameters: `id` (phone detection ID)

30 Delete detected phone

method `deleteProbePhone`

Parameters: `id` (phone detection ID)