檢信情緒分析接口 /接口使用指南 /
根據 AppID 和AppSecret獲得access token
調用接口：
http請求方式: POST
http://接口地址/api/oauth/access_token?appid=f2dcc5e64a0bbac1d667a68630932599&appsecret=4e59e91523a32c594f03f2184e38fedd參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| appid | 是 | String | 應用的appid |
| appsecret | 是 | String | 應用的appsecret |
返回說明：
正常情況下，接口會返回如下 JSON格式 數據包。
{
"code":200,
"access_token":"ACCESS_TOKEN",
"access_time":7200
"msg":''
}
| 參數 | 說明 |
|---|---|
| code | 請求的狀態碼（狀態碼查詢） |
| access_token | 獲取到的憑證（每請求一次接口，憑證就會自動刷新一次，一個應用每天最多刷新24次,考慮到后續的接口調用都需要使用憑證，建議獲取到憑證后進行本地存儲及驗證） |
| access_time | 憑證有效時間，單位：秒 |
| msg | 異常情況，直接返回錯誤信息 |
錯誤時會返回錯誤碼等信息，JSON格式數據包示例如下（該示例為 appid 無效錯誤）:
{
"code":40005,
"msg":"invalid appid"
}
上傳視頻
調用接口：
http請求方式: POST
http://接口地址/api/sns/upload?access_token=4f4b31697e07a7b3f642d0f797034317&age=30&sex=男&base64=UklGRjwYDgBBVkkgTElTVH4iAABoZHJsYXZpaDgAAAA1...&businessid=202302211102131441520
參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
| age | 是 | String | 檢測者年齡 |
| sex | 是 | String | 檢測者性別 |
| base64 | 是 | String | 視頻的base64位編碼 |
| businessid | 否 | String|Int | 用戶自定義的業務編號，該編號會在消息推送接口一并返回 |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"code":200,
"orderid":"20230211233509673085000003",
"businessid":"202302211102131441520"
}
返回字段說明：
| 參數 | 說明 |
|---|---|
| code | 請求的狀態碼（狀態碼查詢） |
| orderid | 產生的報告單號，在報告查詢時使用。 |
| businessid | 用戶自定義的業務ID |
| msg | 異常情況，直接返回錯誤信息 |
獲取情緒檢測報告
調用接口：
http請求方式: POST
http://接口地址/api/sns/report?access_token=4f4b31697e07a7b3f642d0f797034317&orderid=20230211233603397158000003參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
| orderid | 是 | String | 視頻上傳接口返回的報告單號 |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"status": "success",
"msg": "",
"code": 200,
"data": {
"result": "焦慮癥",
"duration": 30,
"sew": {
"GJX": {
"normal": [20, 50],
"min": 21.0831,
"max": 59.2139,
"m": 44.4565,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"YL": {
"normal": [20, 40],
"min": 11.5746,
"max": 56.6466,
"m": 22.6497,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"JZ": {
"normal": [15, 40],
"min": 4.41319,
"max": 44.0837,
"m": 34.8166,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"KY": {
"normal": [20, 50],
"min": 23.3193,
"max": 43.6674,
"m": 31.9641,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"PH": {
"normal": [50, 100],
"min": 20.4797,
"max": 85.2239,
"m": 70.6762,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"ZX": {
"normal": [40, 100],
"min": 46.9973,
"max": 86.3399,
"m": 79.6988,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"NL": {
"normal": [10, 50],
"min": 19.3205,
"max": 49.6164,
"m": 28.2987,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"ZWTJ": {
"normal": [50, 100],
"min": 47.1108,
"max": 83.5971,
"m": 75.545,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"YY": {
"normal": [15, 25],
"min": 12.0267,
"max": 41.247,
"m": 14.9937,
"s": 21.0831,
"v": 21.0831,
"r": 1
},
"SJZ": {
"normal": [15, 50],
"min": 1.71373,
"max": 97.7707,
"m": 44.6925,
"s": 21.0831,
"v": 21.0831,
"r": 0
},
"XC": {
"normal": [20, 50],
"min": 12.4852,
"max": 31.3234,
"m": 18.1546,
"s": 21.0831,
"v": 21.0831,
"r": 1
},
"XFG": {
"normal": [40, 100],
"min": 24.8478,
"max": 34.2842,
"m": 30.8976,
"s": 21.0831,
"v": 21.0831,
"r": 0
}
},
"qxzs": {
"value": 1.16577,
"result": "正常"
},
"qxfb": {
"goodV": 0.52,
"badV": 0.253,
"phyV": 0.227
},
"hld": {
"value": 2.25,
"result": "普通"
},
"jzd": {
"value": 26.42,
"result": "低"
},
"xgzs": {
"extroV": 63.468,
"stableV": 51.801
},
"jkzb": {
"status": 0,
"relative": {
"value": 0,
"result": "\u01a9[R] = 21.75 (>20.0) "
},
"balance": {
"value": 0,
"result": "\u01a9[\u0394M] = 1.87 (<4.0) "
},
"AI": {
"value": 0,
"result": "AI = 5 (<20) "
}
},
"ew": "您的預警狀況為：欠佳",
"pp": [0, 0, 0, 0, 0, 0, 1597, 0, 2225, 0, 0, 1442, 0, 1716, 0, 0, 2102, 0, 0, 2691, 0, 3588, 0, 0, 4628, 0, 5406, 0, 0, 7723, 0, 8621, 0, 0, 13521, 0, 0, 19593, 0, 24511, 0, 0, 26465, 0, 33284, 0, 0, 35983, 0, 37173, 0, 0, 39313, 0, 0, 36524, 0, 36995, 0, 0, 39351, 0, 41067, 0, 0, 36403, 0, 42121, 0, 0, 47590, 0, 0, 46875, 0, 47014, 0, 0, 52492, 0, 61587, 0, 0, 68245, 0, 0, 72416, 0, 79035, 0, 0, 87695, 0, 110341, 0, 0, 120272, 0, 134902, 0, 0, 159590, 0, 0, 179956, 0, 191726, 0, 0, 211149, 0, 228835, 0, 0, 255151, 0, 274303, 0, 0, 291231, 0, 0, 306069, 0, 306059, 0, 0, 321536, 0, 332622, 0, 0, 337734, 0, 343023, 0, 0, 325323, 0, 0, 338279, 0, 334348, 0, 0, 330860, 0, 308836, 0, 0, 292063, 0, 266826, 0, 0, 230359, 0, 0, 215258, 0, 205429, 0, 0, 196778, 0, 199120, 0, 0, 203379, 0, 0, 202106, 0, 209333, 0, 0, 217516, 0, 210991, 0, 0, 203776, 0, 197523, 0, 0, 194962, 0, 0, 171975, 0, 154245, 0, 0, 137461, 0, 133442, 0, 0, 131545, 0, 126362, 0, 0, 125621, 0, 0, 98586, 0, 84347, 0, 0, 65405, 0, 41944, 0, 0, 23216, 0, 8322, 0, 0, 3643, 0, 0, 982, 0, 1989, 0, 0, 732, 0, 597, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
}
}返回字段說明：
| 參數 | 說明 |
|---|---|
| code | 請求的狀態碼（狀態碼查詢） |
| msg | 返回的消息 |
| data | 報告檢測數據（Object） |
| result | 報告分析結果。 |
| duration | 檢測的視頻時長。 |
| businessid | 用戶自定義的業務ID |
| sew | 十二維度數據 Object (具體參數) |
| qxzs | 十二維情緒指數 value：數據值 result：分析結果 |
| qxfb | 情緒分布 goodV：正面情緒 badV：負面情緒 phyV：生理情緒 |
| hld | 活力度指數 value：數據值 result：分析結果 |
| jzd | 集中度指數 value：數據值 result：分析結果 |
| xgzs | 性格指數 extroV：內/外向性數值 stableV：穩定性數值 |
| jkzb | 健康指標 status：健康狀態[0：正常, 1：異常，2:預警] relative：生理系統參數相關性 (value：數據值[0：正常，1:預警]，result：分析結果) balance：人體微運動平衡性 (value：數據值[0：正常，1:預警]，result：分析結果) AI：AI（范圍） (value：數據值[0：正常，1:預警]，result：分析結果) |
| pp | 頻譜數據() |
可根據實際項目需求，返回指定的數據。
十二維情緒參數說明：
| 參數 | 說明 |
|---|---|
| GJX | 攻擊性
normal: 正常值范圍,
min: 最小值, max: 最大值, m: 平均值, s: 方差, v: 變化率, r: 分析結果 [0：正常，1：偏低，2：偏高] |
| YL | 壓力... |
| JZ | 緊張... |
| KY | 可疑... |
| PH | 平衡... |
| ZX | 自信... |
| NL | 能量... |
| ZWTJ | 自我調節... |
| YY | 郁悶... |
| SJZ | 神經質... |
| XC | 消沉... |
| XFG | 幸福感... |
獲取生理檢測報告
調用接口：
http請求方式: POST
http://接口地址/api/sns/phy?access_token=4f4b31697e07a7b3f642d0f797034317&orderid=20230211233603397158000003參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
| orderid | 是 | String | 視頻上傳接口返回的報告單號 |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"msg": "",
"code": 200,
"orderid": "20240225233254248626000002",
"businessid": "1000",
"data": {
"hrv_result": 0,
"sum": 20,
"mean_hr": 74.45,
"max_hr": 84.43,
"min_hr": 61.24,
"std_hr": 2.78,
"breathe": 17,
"sbp": 113,
"dbp": 78,
"bl_o2": 98,
"psyc_pressure": 51,
"mean_nni": 820.1,
"sdnn": 108.76,
"sdsd": 33.71,
"rmssd": 36.25,
"median_nni": 821.3,
"range_nni": 109.95,
"cvsd": 0.0423,
"cvnni": 0.0383,
"nni_50": 2.2,
"pnni_50": 12.74,
"nni_20": 8.9,
"pnni_20": 53.03,
"lf": 383.19,
"hf": 200.57,
"lf_hf_ratio": 2.31,
"lfnu": 65.7,
"hfnu": 34.3,
"total_power": 664.35,
"vlf": 80.59,
"csi": 1.47,
"cvi": 4.12,
"modified_csi": 223.83,
"kangya": "抗壓能力：偏低",
"pingheng": "交副平衡：正常",
"tiaojie": "心血管調節：偏低",
"huoyue": "自主活性：偏低",
}
}返回字段說明：
| 參數 | 說明 |
|---|---|
| code | 請求的狀態碼（狀態碼查詢） |
| orderid | 產生的報告單號，在報告查詢時使用。 |
| businessid | 用戶自定義的業務ID |
| data | 生理檢測報告數據 Object (具體參數) |
| msg | 異常情況，直接返回錯誤信息 |
生理檢測報告數據字典：
僅展示部分常用參數
| 參數 | 說明 |
|---|---|
| hrv_result | 分析結果（0：表示分析正常，-1：表示分析失敗） |
| mean_hr | 心率 |
| max_h | 最大心率 |
| min_hr | 最小心率 |
| breathe | 呼吸 |
| sbp | 血壓高壓 |
| dbp | 血壓低壓 |
| bl_o2 | 血氧 |
| psyc_pressure | 心率變異或者心理壓力 |
| kangya | 抗壓能力 |
| pingheng | 交感副交感平衡 |
| tiaojie | 心血管調節 |
| huoyue | 自主神經活性 |
獲取量表
調用接口：
http請求方式: POST
http://接口地址/api/sns/scale?access_token=4f4b31697e07a7b3f642d0f797034317參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"msg": "",
"code": 200,
"data": [{
"name": "焦慮自評量表SAS",
"description": "焦慮自評量表（Self-ratingAnxietyScale，簡稱SAS），Zung(1971)提出此量表的目的，是為了研究個體在心理層面上，因某些原因導致焦慮癥狀，運用自我自量的方式進行測量，一般較為普遍運用的領域是心理科學。我國學者王征宇及遲玉芬(1984)依據我國民情翻譯為中文版本，量表共計20個條目。",
"model": "sas"
},
{
"name": "抑郁自評量表SDS",
"description": "抑郁自評量表（Self-RatingDepressionScale，簡稱SDS），Zung(1965)提出此量表的目的，是為了研究個體在心理層面上，持續出現的特征，如：悲傷、絕望等癥狀，運用自我自量的方式進行測量，一般較為普遍運用的領域是醫學。我國學者王征宇及遲玉芬(1984)依據我國民情翻譯為中文版本，量表共計20個條目。 ",
"model": "sds"
},
...
]
}返回字段說明：
| 參數 | 說明 |
|---|---|
| code | 請求的狀態碼（狀態碼查詢） |
| msg | 異常情況，直接返回錯誤信息 |
| data | 量表數據 Array 數組 字段說明： { name: 量表名稱 description: 量表介紹 model: 量表模型 } |
獲取量表題目
調用接口：
http請求方式: POST
http://接口地址/api/sns/topic?access_token=4f4b31697e07a7b3f642d0f797034317&model=sas參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
| model | 是 | String | 量表模型 |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"msg": "",
"code": 200,
"data": [
{
"id": "1",
"title": "我覺得比平常容易緊張和著急",
"type": "0",
"options": [
{
"id": "1",
"no": "A",
"name": "沒有或很少時間"
},
{
"id": "3",
"no": "B",
"name": "小部分時間"
},
{
"id": "4",
"no": "C",
"name": "相當多時間"
},
{
"id": "5",
"no": "D",
"name": "絕大部分或全部時間"
}
]
},
...
]
}返回字段說明：
量表題庫數據字典
| 參數 | 說明 |
|---|---|
| id | 試題編號 |
| title | 試題標題 |
| type | 試題類型（0:選擇題，1：判斷題） |
| options | 試題答案選項 Array 數組 字段說明： { id: 選項編號 no: 選項編號文本 name: 選項標題 } |
獲取量表檢測結果
調用接口：
http請求方式: POST
http://接口地址/api/sns/scalereport?access_token=4f4b31697e07a7b3f642d0f797034317&answer=[["21","83"],["22","88"],...]參數說明：
| 參數 | 是否必須 | 參數類型 | 說明 |
|---|---|---|---|
| access_token | 是 | String | 根據 appid 和 appsecret獲取到的token憑證 |
| model | 是 | String | 量表模型 |
| answer | 是 | Array | 答案([["21","83"],["22","88"],...]) 二維數組 ，每個數組元素包含試題編號和對應的答案編號，即[["試題編號","答案編號"],["試題編號","答案編號"],...] |
返回說明：
正常情況下，接口會返回下述 JSON 數據包。
{
"msg": "",
"code": 200,
"data": {
"scalename": "抑郁自評量表SDS",
"totalscore": 45,
"scaledscore": 56,
"result": "通過測試表明被試屬于輕度抑郁。偶爾有些郁悶、壓抑。被測者在遇到挫折和煩惱時,會出現暫時的情緒低落。 ",
"suggest": "被試需要認識到這些情緒，并學習條件情緒的方法，參考建議： (1)不要掩飾自己的情緒、過多地壓抑自己,要學會傾訴和宣泄等方式來進行自我調節,如寫日記,散步或者找朋友聊聊天,努力使自己保持樂觀、向上的心態。(2)也可在相關心理學知識的指導下,培養積極的認知方式,改變對自己的認識,全面認識自我,悅納自我,善待自我。(3)定期復查，若無改善需做心理咨詢或轉介專業門診。"
}
}返回字段說明：
量表檢測結果解析
不同的量表，返回的檢測結果可能會不一樣。
| 量表 | 模型 | 返回結果參數說明 |
|---|---|---|
| 焦慮自評量表 | sas |
scalename：量表名稱 totalscore： 總分 scaledscore：量表實測得分 result：檢測結果 suggest：建議 |
| 抑郁自評量表 | sds |
scalename：量表名稱 totalscore: 總分 scaledscore: 量表實測得分 result: 檢測結果 suggest: 建議 |
| 90項癥狀自評量表 | scl90 |
scalename：量表名稱 totalscore: 總分 index: 總癥狀指數 positive: 陽性項目數 avgscore: 陽性癥狀均分 factor：因子項 Array 數組（具體參數） avgresult: 陽性檢測結果 avgsuggest: 陽性建議 result: 檢測結果 suggest: 建議 |
| MHT心理健康量表 | mht |
scalename：量表名稱 totalscore: 總分 factor：因子項 Array 數組（具體參數） result: 檢測結果 suggest: 建議 |
| PHQ-9抑郁癥篩查量表 | phq9 |
scalename：量表名稱 totalscore: 總分 scaledscore: 量表實測得分 result: 檢測結果 suggest: 建議 |
| 少兒心理健康量表 | mfsca |
scalename：量表名稱 totalscore: 總分 factor：因子項 Array 數組（具體參數） result: 檢測結果 suggest: 建議 |
| 中學生心理健康量表 | mssmhs |
scalename：量表名稱 totalscore: 總分 factor：因子項 Array 數組（具體參數） result: 檢測結果 suggest: 建議 |
| 霍蘭德職業傾向測試 | holland |
scalename：量表名稱 totalscore: 總分 factor：因子項 Array 數組（具體參數） result: 檢測結果 suggest: 建議 |
| 青少年生活事件量表 | aslec |
scalename：量表名稱 totalscore: 總分 state: 總測評狀態 factor：因子項 Array 數組（具體參數） result: 檢測結果 suggest: 建議 |
因子項具體參數
| 參數 | 說明 |
|---|---|
| name | 因子項名稱 |
| score | 因子項得分 |
| state | 測評狀態（輕，較輕，較重，重，嚴重），部分量表沒有此返回值 |
| result | 因子項檢測結果 |
| suggest | 因子項檢測建議 |
消息推送服務
消息推送服務需提前將應用與消息接收接口綁定，消息接收接口由開發者提供，服務端在給出分析報告后會將報告數據以JSON格式推送到接收接口，參數可參照報告獲取接口返回的參數。
接收示例：
PHP數據接收示例
$stream = file_get_contents("php://input");
try{
$json = json_decode($stream);
echo("訂單號:".$json->orderid.",檢測結果：".$json->result.",檢測時間：".$json->duration);
}catch(Exception $e){
//數據接收失敗;
}返回碼code說明
| 值 | 說明 |
|---|---|
| -1 | 請求失敗 |
| 200 | 請求成功 |
| 30001 | 服務器無響應 |
| 40001 | access_token 無效 |
| 40002 | access_token 未通過驗證 |
| 40003 | access_token 已過期 |
| 40004 | 缺少必要參數 |
| 40005 | appid 無效 |
| 40006 | appsecret 無效 |
| 40007 | 用戶不存在 |
| 40008 | 應用已被下架 |
| 40009 | 賬戶余額不足 |
| 40010 | access_token 每日刷新次數已達上限 |
| 40011 | 應用與服務器未建立合約關系 |
| 40012 | 無效的參數 |
| 40013 | 缺少視頻的base64位編碼 |
| 40014 | 無效的視頻參數 |
| 40015 | 視頻上傳失敗 |
| 40016 | 無效的單號 |
| 40017 | 單號不存在 |
| 40018 | 暫未生成報告 |
| 40019 | 報告不存在 |
| 40020 | appid 或 appsecret 無效（沒有查詢到對應的應用） |
| 40021 | 支付失敗 |
| 40022 | 未開通服務 |
| 40023 | 量表不存在 |
| 40024 | 量表檢測未完成 |
| 40025 | 無效的檢測結果 |