收款雲音箱雲喇叭API開發接口文檔(2020-4-20)

雲音箱服務對接指南

  

 微擎模塊頁面廣告2.jpg

 

QQ圖片20190410104424.jpg

雲喇叭設置小助手

一、名詞解釋 

 

1、雲音箱 ID (SPEAKERID): 

雲音箱機身上帖有云音箱的 ID 碼,每臺雲音箱擁有唯一永久 ID,SPEAKERID由字母、數字組成, 在生產過程中寫入雲音箱,雲音箱出廠後不會再改變。 

  

2、TOKEN:  

廠商分配給每個代理商的唯一 token, 通過安全渠道提供給代理商,使得代理商對它購買的SPEAKERID 有操作權限。若報文中提交的token錯誤或token無權操作報文中提交的SPEAKERID,服務器會返回錯誤。

token是一個長度爲12字節的字符串,包含數字和英文字母,區分大小寫。 基於安全角度,token可能會不定期更新,廠商會提前通知代理商。

例如:廠商給某個代理的 token 是 100286158508,並向其銷售了 speakerid 爲 1000 到 1999 的一千個雲音箱,則該代理用 100286158508 這個 token 能且僅能 操作 speakerid 爲 1000 到 1999 的雲音箱。其它代理由於不知道這個 token,無法操作這一千個雲音箱。 

 

3、代理商 ID (AGENCYID): 

token 的前 4 位即爲 AGENCYID,每個代理商唯一。是一個 1000 到 9999 的數值。 例如,某代理商的 token 爲 10053581315,即此代理商的 AGENCYID 爲 1005。 

 

4、用戶ID (USERID): 

代理商會給每位雲音箱使用人分配一個唯一的帳號,這個帳號會有相關聯的支付服務商下商戶賬號,用來接收相應的收款消息。一個用戶帳號可以綁定多個雲音箱,目前暫定單個用戶最多可以綁定的有效喇叭數爲 300 個。 這個 USERID 是字符串,長度最大 255 字節,可使用英文字母和數字和下劃線, 區分大小寫。 例如: 某個飯店商戶在代理商註冊了個帳戶叫“張三”,爲避免重複,並且爲了使用字母和數字,代理商分配給他的帳號名爲”zhang3_2017”,於是代理商可以 用”zhang3_2017”來綁定例如 ID 爲 1090 的雲音箱,並且代理商用”zhang3_2017”來 提交支付消息,服務器會將此支付消息推送到 ID 爲 1090 的雲音箱。

 

 

二、接口 

 

1、通訊協議

 

1)接口地址:http://cloudspeaker.smartlinkall.com 

2)協議和端口號: HTTP 80,HTTPS 443  

3)請求方式:GET 或 POST 

4)提交數據格式:

id=SPEAKERID&uid=USERID&price=PRICEVALUE&token=TOKEN

5)返回數據格式:JSON

參數

類型

說明 

必須

errcode

integer

返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

 

6)網關返回碼

成功

未知錯誤

SPEAKERID 不存在

SPEAKERID 已經被其它用戶 ID 綁定

SPEAKERID 已經被同一用戶 ID 綁定

SPEAKERID 未被任何用戶 ID 綁定

未提供 SPEAKERID

此 token 無此 SPEAKERID 權限

無效的 token

17 

重複的請求

 

本文檔接口表格中各列意義說明: 

·                         “參數”列: 指提交 GET 或 POST 方式時帶的參數名稱字符串,編程時使用

·                         “意義”列: 解釋參數名稱的意義,僅爲了利於記憶,不是編程時的字符串 

·                         “必須”列:帶*號表示此參數是必須的,不能缺少

 

 

2、基礎接口

基礎接口爲雲音箱正常工作的必備接口,代理商必須實現

 

2.1 雲音箱綁定或解綁

最終用戶在手機專用客戶端(或網頁)上輸入(或掃描)雲收款 ID,提交到雲音箱服務器,服務器的數據表將此用戶帳號與雲音箱 ID 作關聯。出於安全考慮, 代理商在將賬號與雲音箱 ID 作綁定前,要確認操作人是該雲音箱的擁有者。 比如,用戶在申請綁定時,代理商提交一條隨機支付消息到該雲音箱,用戶收聽播報價格後輸入給代理商,代理商確認用戶輸入的數字與提交的數字相同,即可驗證。原理類似於手機驗證碼。出於安全考慮,已經綁定過帳號的雲音箱 ID 不允許更改綁定到其它帳號, 除非原帳戶人申請解綁此雲音箱。

 

1)URL:  http://cloudspeaker.smartlinkall.com/bind.php

 

2)請求參數:

參數

意義 

說明 

必須

id 

SPEAKERID 

雲音箱的 ID 

*

METHOD 

0 爲解綁, 1 爲綁定, 4 強制解綁(不需提供原 USERID) 

*

uid 

USERID 

用戶帳號 ID,申請與雲音箱 ID 綁定/解綁的用戶帳號 ID,必
須每個用戶唯一

*

token 

TOKEN 

代理商的 token, 預先通過安全渠道分配,使得代理商對該SPEAKERID 有操作權限

*

seq 

SEQUENCY 

用 於通訊 去重複 的順序號 ,範圍 爲 [0,4294967295] ( 即[0,0xFFFFFFFF])的整數。每次提交時請改變此值(比如按順序
加 1)。
假如服務器在 200 秒(暫定值)內收到兩個或多個 SEQUENCY相同、並且提交的內容也相同的請求,則認爲是重複提交,
將忽略此請求,並返回錯誤碼 17。
此參數缺省時,服務器對此次請求不做去重檢查,此次請求
也不作爲後續去重檢查的比較依據。

 

descs 

DESCRIPTION 

代理商可以給此綁定請求提供一個描述字符串,最大 255 個
字節。之後代理商用 “ 綁定狀態查詢接口”查詢綁定消息時,
可以看到此描述。
此參數對雲音箱或服務器工作狀態沒有影響。

 

 

 

 

例子1:

http://cloudspeaker.smartlinkall.com/bind.php?id=335&m=1&uid=AF337099&token=100170095533

表示申請將用戶 ID AF337099 與雲音箱 335 綁定

 

例子2:

http://cloudspeaker.smartlinkall.com/bind.php?id=335&m=0&uid=AF337099&token=100170095533

表示申請將用戶 ID AF337099 與雲音箱 335 解除綁定

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

 

 

2.2 支付語音播報

將支付結果提交到雲音箱服務器、服務器將支付結果推送給雲音箱,雲音箱接收後播報。

 

1URLhttp://cloudspeaker.smartlinkall.com/add.php

 

2)請求參數:

參數

意義 

解釋 

必須

id 

SPEAKERID 

指該雲音箱的 ID

*

uid 

USERID 

用戶帳號 ID,申請與雲音箱 ID 綁定的用戶帳號 ID, 必須每個用戶唯一

 

price 

PRICEVALUE 

指支付金額值的字符串,單位爲分,範圍爲 1 至2147483647,即 1 分到 2 千多萬。

*

pt 

PRICE_TYPE 

支付類型,此參數會讓雲音箱播放不同的提示語音
一個[0,255]的整形值,目前定義如下:
1  支付寶 

2  微信支付 

3  雲支付 

4  餘額支付 

5  微信儲值 

6  微信買單 

7  銀聯刷卡  

8  會員卡消費

9  會員卡充值

10 翼支付

11 退款 

12 支付寶退款 

13 微信退款 

14 銀行卡退款 

15 銀聯退款 

16 工行e支付 

18 QQ錢包到賬

19 京東支付

20 用戶取消支付

22 西銀惠支付

*

token 

TOKEN 

代理商的 token, 預先通過安全渠道分配,使得代理商對該 SPEAKERID 有操作權限

*

vol 

VOLUME 

指音量設置值,範圍爲 0 到 100,代表從無音到最大聲。 

 

seq 

SEQUENCY 

用於通訊去重複的順序號,範圍爲[0,4294967295] (即[0,0xFFFFFFFF])的整數。每次提交時請改變此值(比如按順序加 1)。
假如服務器在 200 秒(暫定值)內收到兩個或多個SEQUENCY 相同、並且提交的內容也相同的請求,則認爲是重複提交, 服務器將忽略此提交,並返回錯誤碼 17。此參數缺省時,服務器對此次請求不做去重檢查,此次請求也不作爲後續去重檢查的比較依據。

 

trace_no 

TRACE_
NUMBER

代理商用於追蹤此支付消息的一個字符串,最大 63個字節,由代理商軟件產生。之後代理商可以用此trace_no 通過用“支付消息歷史查詢接口”查詢該條支付消息。此參數對雲音箱或服務器工作狀態沒有影響。

 *

descs 

DESCRIPTION 

代理商可以給此支付消息一個描述字符串,最大 255個字節。之後代理商用 “支付消息歷史查詢接口”查詢支付消息時,可以看到此描述。此參數對雲音箱或服務器工作狀態沒有影響。

 

suffix

VOLUMESUFFIX  

是否開啓自定義收款消息後綴, 1表示開啓

 

備註:

雲音箱收到支付結果後,播放內容爲:支付類型 + 金額 + 後綴,後綴和前綴可以通過“更改語音信息”接口修改

 

例子:

http://cloudspeaker.smartlinkall.com/add.php?id=335&price=3879&token=100170095533

表示代理商的 token 爲 100170095533,向 id 爲 335 的雲音箱提交支付金額爲 38.79 元的支付結果

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

 

 

3、可選接口

代理商可根據情況實現可選接口,可選接口不影響雲音箱的正常使用。

 

3.1 通知語音播報

將通知消息提交到雲音箱服務器、服務器將支付結果推送給雲音箱,雲音箱接收後播報。

備註:該接口爲2G版音箱專用接口,通過2G版音箱自帶的TTS播放,WIFI版音箱不可用

 

1URLhttp://cloudspeaker.smartlinkall.com/notify.php

 

2)請求參數:

參數

意義 

解釋 

必須

 

id 

SPEAKERID 

雲音箱的 ID 

*

 

token 

代理商的 token

代理商的 token, 預先通過安全渠道分配,使得代理商對該SPEAKERID 有操作權限

*

 

message

MESSAGE

通知消息內容,長度最長128個字節

*

 

seq 

SEQUENCY 

用 於通訊 去重複 的順序號 ,範圍 爲 [0,4294967295] ( 即[0,0xFFFFFFFF])的整數。每次提交時請改變此值(比如按順序
加 1)。
假如服務器在 200 秒(暫定值)內收到兩個或多個 SEQUENCY相同、並且提交的內容也相同的請求,則認爲是重複提交,
將忽略此請求,並返回錯誤碼 17。
此參數缺省時,服務器對此次請求不做去重檢查,此次請求
也不作爲後續去重檢查的比較依據。

 

 

vol 

VOLUME 

指音量設置值,範圍爲 0 到 100,代表從無音到最大聲。 

 

 

speed

SPEED

語速,速度範圍爲0-100,默認爲65

 

 

trace_no 

TRACE_
NUMBER

代理商用於追蹤此支付消息的一個字符串,最大 63個字節,由代理商軟件產生。之後代理商可以用此trace_no 通過用“支付消息歷史查詢接口”查詢該條支付消息。此參數對雲音箱或服務器工作狀態沒有影響。

 *

 

例子1:
http://cloudspeaker.smartlinkall.com/notify.php?id=10000091&token=099935813151&message=你的驗證碼爲6688 

ID爲10000091的雲音箱播報語音 “你的驗證碼爲6688”

 

例子1:
http://cloudspeaker.smartlinkall.com/notify.php?id=10000091&token=099935813151&message=支付寶到賬120元,實收110元,星POS爲你優惠10元 

ID爲10000091的雲音箱播報語音 “支付寶到賬120元,實收110元,星POS爲你優惠10元”

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

 

3.2 更改語音信息

更改開機語音,自定義播報前綴,播報後綴。

 

1URLhttp://cloudspeaker.smartlinkall.com/modify_bootvoice.php

 

2)請求參數:

參數

意義 

解釋 

必須

id 

SPEAKERID 

雲音箱的 ID 

*

token 

TOKEN 

代理商的 token, 預先通過安全渠道分配,使得代理商對該SPEAKERID 有操作權限

*

sound

SOUNDCOTENT

聲音內容

中文最長15字

其他字節30字節

*

type

TYPE

類型

0 表示開機歡迎聲音

1 支付信息播報前綴

2 支付信息播報後綴

*

seq 

SEQUENCY 

用 於通訊 去重複 的順序號 ,範圍 爲 [0,4294967295] ( 即[0,0xFFFFFFFF])的整數。每次提交時請改變此值(比如按順序
加 1)。
假如服務器在 200 秒(暫定值)內收到兩個或多個 SEQUENCY相同、並且提交的內容也相同的請求,則認爲是重複提交,
將忽略此請求,並返回錯誤碼 17。
此參數缺省時,服務器對此次請求不做去重檢查,此次請求
也不作爲後續去重檢查的比較依據。

 

descs 

DESCRIPTION 

代理商可以給此綁定請求提供一個描述字符串,最大 255 個
字節。之後代理商用 “ 綁定狀態查詢接口”查詢綁定消息時,
可以看到此描述。
此參數對雲音箱或服務器工作狀態沒有影響。

 

例子:
http://cloudspeaker.smartlinkall.com/modify_bootvoice.php?id=10000091&token=099935813151&sound=歡迎光臨&type=0   

表示將雲喇叭 ID 10000091 開機語音設置爲 “歡迎光臨”

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

 

 

3.3 雲音箱綁定狀態查詢

查詢某些(或某個) 雲音箱 ID, 或者某個用戶帳號的綁定情況。

 

1) URL: http://cloudspeaker.smartlinkall.com/list_bind.php

 

2) 請求參數:

參數

意義

解釋

必須

ids

START_SPEAKERID

查詢方式

 

方式一

雲音箱的起始 ID,如果爲空,表示不限制起始 ID

*

ide 

END_SPEAKERID 

雲音箱的結束 ID,如果爲空,表示不限制結束 ID

id 

SPEAKERID 

方式二

雲音箱的 ID可以是單個喇叭 ID,也可以是範圍或枚舉。範圍以減號連接,包含兩頭值;枚舉以逗號分隔。
例如:
1000,1005,1008-1011,1015表示喇叭 ID 爲:
1000,1005,1008,1009,1010,1011,101

uid 

USERID 

方式三

用戶帳號 ID,申請與雲音箱 ID 綁定的用戶帳號 ID,必須每個用戶唯一

ts 

START_TIME 

查詢條件

 

 

指只查詢這個時間或這個時間之後的記錄,時間格式如下:一段 14 字節的字符串 , 格式爲YYYYMMDDHHmmss其中四字節年,兩字節月份,兩字節日,兩字節小時(24 小時制),兩字節分鐘,兩字節秒

例如: 20170927173500 表示2017 年 9 月 27 日 17 時 35 分零秒此參數如果缺省, 表示不限制起始時間。

 

te 

END_TIME 

指只查詢這個時間或這個時間之前的記錄,時間格式同上。此參數如果缺省, 表示不限制結束時間。

 

descs 

DESCRIPTION 

查詢代理綁定消息時提交的 DESC 標識。目前暫不提供%的模糊查詢

 

fm 

FORMAT 

返回格式 

指定數據返回格式, 0 爲內部調試用的 Html 表格格式, 1 爲純文本, 2爲 Microsoft Excel 的.csv, 3 爲 json;缺省時爲 3

 

PAGE 

顯示分頁

 

 

輸出的頁號,整數值,從 0 開始。爲了防止每次返回數據太多造成服務器超時,服務器每次 只返回PAGESIZE 條(缺省爲 200)記錄。p=0 時表示返回最開頭的 200 條,即第 0 條到第 199 條。p=1 表示返回第 200 到第 399 條。 以此類推。當用戶查詢到 p=n 時返回記錄數爲零,說明可以停止繼續查詢後續頁。此參數缺省值爲 0。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

pi 

PAGEITEM 

指定當前顯示頁是從第幾條結果開始顯示。
例如 pi=350,表示當前頁是從第 350條結果開始。
此參數缺省值爲 0。此參數不要與 PAGE 同時用,否則會
忽略 PAGE 參數。例如,當 PAGESIZE 爲 200 時, PAGE爲 2 與 PAGEITEM 爲 400 的效果與等同。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

ps 

PAGESIZE 

每頁顯示的結果條數。缺省爲 200。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

token 

TOKEN 


代理商的 token

代理商的 token, 預先通過安全渠道分配,使得代理商對該 SPEAKERID 有操作權限

 

例子1:

http://cloudspeaker.smartlinkall.com/list_bind.do?ids=1000&ide=1030&uid=wangxi2017&token=100013483324

表示查詢雲音箱範圍爲 1000 到 1030 並且用戶 ID 爲 wangxi2017 的綁定記錄

 

例子2:

http:// cloudspeaker.smartlinkall.com/list_bind.do?fm=0&id=1000&token=100013483324

表示查詢雲音箱 ID 1000 的綁定記錄

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

detail 說明:

1)結果表中的 userid, 前 4 位爲代理商 ID (AGENCYID),第 6 位開始纔是真實用戶 ID。(這是爲了保證不同代理商用相同用戶 ID 時,用戶 ID 在表中是唯一的)例如: userid 1000_wangxi2007, 其真實用戶 id 爲 wangxi2007結果表中 real_userid 是真實用戶 id

2)結果表中 active, 值 1 表示綁定是有效狀態,值 0 表示以前綁定過但是後來已經解綁了。

 

 

3.4 查詢雲音響操作權限

代理商查詢其對哪些喇叭有操作權

1)URL:http://cloudspeaker.smartlinkall.com/list_speakeragency.php

 

2)請求參數:

參數

意義

解釋

必須

ids

START_SPEAKERID

查詢方式

 

方式一

雲音箱的起始 ID,如果爲空,表示不限制起始 ID

*

ide 

END_SPEAKERID 

雲音箱的結束 ID,如果爲空,表示不限制結束 ID

id 

SPEAKERID 

方式二

雲音箱的 ID可以是單個喇叭 ID,也可以是範圍或枚舉。範圍以減號連接,包含兩頭值;枚舉以逗號分隔。
例如:
1000,1005,1008-1011,1015表示喇叭 ID 爲:
1000,1005,1008,1009,1010,1011,101

uid 

USERID 

方式三

用戶帳號 ID,申請與雲音箱 ID 綁定的用戶帳號 ID,必須每個用戶唯一

ts 

START_TIME 

查詢條件

 

 

指只查詢這個時間或這個時間之後的記錄,時間格式如下:一段 14 字節的字符串 , 格式爲YYYYMMDDHHmmss其中四字節年,兩字節月份,兩字節日,兩字節小時(24 小時制),兩字節分鐘,兩字節秒

例如: 20170927173500 表示2017 年 9 月 27 日 17 時 35 分零秒此參數如果缺省, 表示不限制起始時間。

 

te 

END_TIME 

指只查詢這個時間或這個時間之前的記錄,時間格式同上。此參數如果缺省, 表示不限制結束時間。

 

descs 

DESCRIPTION 

查詢代理綁定消息時提交的 DESC 標識。目前暫不提供%的模糊查詢

 

fm 

FORMAT 

返回格式 

指定數據返回格式, 0 爲內部調試用的 Html 表格格式, 1 爲純文本, 2爲 Microsoft Excel 的.csv, 3 爲 json;缺省時爲 3

 

PAGE 

顯示分頁

 

 

輸出的頁號,整數值,從 0 開始。爲了防止每次返回數據太多造成服務器超時,服務器每次 只返回PAGESIZE 條(缺省爲 200)記錄。p=0 時表示返回最開頭的 200 條,即第 0 條到第 199 條。p=1 表示返回第 200 到第 399 條。 以此類推。當用戶查詢到 p=n 時返回記錄數爲零,說明可以停止繼續查詢後續頁。此參數缺省值爲 0。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

pi 

PAGEITEM 

指定當前顯示頁是從第幾條結果開始顯示。
例如 pi=350,表示當前頁是從第 350條結果開始。
此參數缺省值爲 0。此參數不要與 PAGE 同時用,否則會
忽略 PAGE 參數。例如,當 PAGESIZE 爲 200 時, PAGE爲 2 與 PAGEITEM 爲 400 的效果與等同。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

ps 

PAGESIZE 

每頁顯示的結果條數。缺省爲 200。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

token 

TOKEN 

代理商的 token 

代理商的 token, 預先通過安全渠道分配,使得代理商對該 SPEAKERID 有操作權限

 

例子1:

http://cloudspeaker.smartlinkall.com/list_speakeragency.php?ids=1000&ide=1500token=100013483324

查詢ID範圍從1000 到 1500 雲音箱是否有權限

例子2:

http://cloudspeaker.smartlinkall.com/list_bind.php?fm=0&id=1000&token=100013483324

表示查詢雲音箱 ID 1000 是否有權限

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

detail 說明:

{"total_count":1,"list_count":1,"records":{"0":{"ID":"649138","datetime":"2017-11-2820:37:57","speakerid":"1432","agencyid":"1004","active":"1","descs":null}}}

1) 結果表中的 speakerid, 即表示該代理商有權限的喇叭。

2)結果表中 active, 值 1 表示是有效狀態,值 0 表示以前分配過但是後來已經被工廠刪除權限了。

 

 

3.5 查詢第一條未播放語音

代理商向服務器提交支付消息後,假如雲音箱未取走這些支付消息,將會按時間先後存在服務器虛擬隊列中。 代理商可用這個接口查詢這個隊列中最早的一條未被取走的支付消息。例如,代理商向服務器提交雲音箱 ID 爲 335 的支付消息,先後四次提交分別爲 1.35元, 3.77 元, 6.78 元, 4.66 元。而云音箱取走了 1.35 元這條消息。那麼代理商用這個接口查詢的結果是 3.77 元。等到雲音箱又先後取走了 3.77 元、 6.78 元這兩條消息,那麼這個接口的查詢結果將爲 4.66 元。如果要查詢詳細支付消息歷史,請使用後文的支付消息歷史查詢接口。同時,這個接口也可以查詢當前音量值設置值,音量值是最後一次提交的設置值,與是否被雲音箱取走無關。

 

1)URL:http://cloudspeaker.smartlinkall.com/get_last.php

 

2)請求參數:

參數

意義

解釋

必須

id 

SPEAKERID 

指該雲音箱的 ID

*

token

TOKEN 

代理商的 token

*

例子: 

http://cloudspeaker.smartlinkall.com/get_last.do?id=10000091&token=09993581315

查詢 ID 爲 3998 的雲音箱的支付消息和音量。

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

detail 說明:
若無錯誤,並且此 ID 有新支付消息,服務器應該回復如下文本字符串:{"price":支付金額,"volume":音量,"price_type":支付類型}其中:支付金額: 一個表示整數的字符串,單位爲分, 範圍爲 1 至 2147483647,即 1 分到 2 千多萬。音量: 一個表示整數的字符串,範圍爲 0-100。(出於用戶體驗考慮,建議只回復40-100 的值,否則音量太小可能會聽不清)金額和音量之間的分隔號是半角英文逗號”,”例如:{"price":3877,"volume":80,"price_type":0 } 表示支付金額 38.77 元,支付類型爲通用類, 當前音量爲 80%,。2. 若無錯誤,但此 ID 沒有新支付消息,服務器應該回復如下文本字符串:{"price":0,"volume":音量,"price_type":0}例如:
{"price":0,"volume":70,"price_type":0} 表示未有新支付消息,當前音量爲 70%

 

3.6 查詢歷史支付消息

查詢提交過的歷史支付結果消息。

 

1)URL:http://cloudspeaker.smartlinkall.com/list.php

 

2)請求參數

參數

意義

解釋

必須

ids

START_SPEAKERID

查詢方式

 

方式一

雲音箱的起始 ID,如果爲空,表示不限制起始 ID

*

ide 

END_SPEAKERID 

雲音箱的結束 ID,如果爲空,表示不限制結束 ID

id 

SPEAKERID 

方式二

雲音箱的 ID可以是單個喇叭 ID,也可以是範圍或枚舉。範圍以減號連接,包含兩頭值;枚舉以逗號分隔。
例如:
1000,1005,1008-1011,1015表示喇叭 ID 爲:
1000,1005,1008,1009,1010,1011,101

uid 

USERID 

方式三

用戶帳號 ID,申請與雲音箱 ID 綁定的用戶帳號 ID,必須每個用戶唯一

ts 

START_TIME 

查詢條件

 

 

指只查詢這個時間或這個時間之後的記錄,時間格式如下:一段 14 字節的字符串 , 格式爲YYYYMMDDHHmmss其中四字節年,兩字節月份,兩字節日,兩字節小時(24 小時制),兩字節分鐘,兩字節秒

例如: 20170927173500 表示2017 年 9 月 27 日 17 時 35 分零秒此參數如果缺省, 表示不限制起始時間。

 

te 

END_TIME 

指只查詢這個時間或這個時間之前的記錄,時間格式同上。此參數如果缺省, 表示不限制結束時間。

 

descs 

DESCRIPTION 

查詢代理綁定消息時提交的 DESC 標識。目前暫不提供%的模糊查詢

 

fm 

FORMAT 

返回格式 

指定數據返回格式, 0 爲內部調試用的 Html 表格格式, 1 爲純文本, 2爲 Microsoft Excel 的.csv, 3 爲 json;缺省時爲 3

 

PAGE 

顯示分頁

 

 

輸出的頁號,整數值,從 0 開始。爲了防止每次返回數據太多造成服務器超時,服務器每次 只返回PAGESIZE 條(缺省爲 200)記錄。p=0 時表示返回最開頭的 200 條,即第 0 條到第 199 條。p=1 表示返回第 200 到第 399 條。 以此類推。當用戶查詢到 p=n 時返回記錄數爲零,說明可以停止繼續查詢後續頁。此參數缺省值爲 0。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

pi 

PAGEITEM 

指定當前顯示頁是從第幾條結果開始顯示。
例如 pi=350,表示當前頁是從第 350條結果開始。
此參數缺省值爲 0。此參數不要與 PAGE 同時用,否則會
忽略 PAGE 參數。例如,當 PAGESIZE 爲 200 時, PAGE爲 2 與 PAGEITEM 爲 400 的效果與等同。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

ps 

PAGESIZE 

每頁顯示的結果條數。缺省爲 200。此參數當 m=0 時無效,因爲 html 表格已經自動分頁。

 

token 

TOKEN 

代理商的 token 

代理商的 token, 預先通過安全渠道分配,使得代理商對該 SPEAKERID 有操作權限

 

例子:

http://cloudspeaker.smartlinkall.com/list.do?ids=335&ide=338&st=20170927000000&et=20170927235959&fm=1&p=0&token=09993581315

查詢喇叭 ID 爲 335,336,337,338,在 2017-09-27 當天的記錄, 開頭 200 條, 返回純文本格式

 

3) 返回參數:

參數

類型

說明 

必須

errcode

integer

返回碼,參見 網關返回碼

*

errmsg

string

返回碼描述 

*

detail

string

返回的數據

 

detail 說明:

查詢後,雲服務器回覆的內容是該雲音箱的歷史消息列表。

 微擎模塊頁面廣告2.jpg

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章