聊天窗口模塊 · SCRM_Api文檔

# 聊天窗口模塊 ## **Web端交互** ![](https://img.kancloud.cn/a2/bf/a2bf00f00cadf7ee64839f0dffb8b7a8_692x848.png) ## **API相關文檔** 接口描述 | **發送圖片消息** ---|--- URL | /wechat_api/message/sendFileMsg 請求方式 | POST 請求參數 | {"uin":"24323538036","msgType":"3","fromUserName":"wxid_1yf4qxydy38b12","toUserName":"wxid_8twmv8pkgvox22","loginer":"2206","type":"pic","tokenId":"sendFile-1552913364779126","fileName":"測試發送圖片","fileUrl":"http://stg-iobs-upload.pingan.com.cn/download/pad-mvp-file-dmz-stg/weremote-tenant-dx-reply-account-TINGKU201-jpg-15616025027401.jpg?name=測試10.jpg","fileSize":"1687" } 返回值 | {"msg": "上傳文件成功","code": 200} | Sort | Param | Type | required | Description | | --- | --- | --- | --- | --- | | 請求參數 |uin|string|Y|uin | 請求參數 |msgType|int|Y|圖片固定為3 | 請求參數 |fromUserName|string|Y|發送者微信號 | 請求參數 |toUserName|string|Y|接收者微信號 | 請求參數 |loginer|int|Y|登錄人ID | 請求參數 |type|string|Y|圖片為pic | 請求參數 |tokenId|string|Y|請求序號,sendFile-14位隨機數 | 請求參數 |fileName|string|Y|圖片文件名 | 請求參數 |fileUrl|string|Y|圖片url | 請求參數 |fileSize|int|Y|圖片大小 > ***** 接口描述 | **檢測發送圖片消息狀態** ---|--- URL | wechat_api/message/getWsReceive 請求方式 | GET - 請求示例 ``` http://192.168.8.90:30097/wechat_api/message/getWsReceive?uin=2123131667&userName=wxid_lbejkr1i6jl922&cmdId=sendMsg-158376014633942 ``` - 返回值示例 ``` { "code":200, "status":"4" } ``` | Sort | Param | Type | Description | ParamDesc | --- | --- | --- | --- | --- | | req | uin | String | 微信號uin | | req | userName | String | 微信號wxid | | req | cmdId | String | 發送消息的tokenId > ***** 接口描述 | **獲取圖片媒體流** ---|--- URL | wechat_api/message/sendMediaMessage 請求方式 | POST Content-Type | application/json;charset=UTF-8 - 請求示例 ``` { "fromUserName":"wxid_8twmv8pkgvox22", "toUserName":"wxid_lbejkr1i6jl922", "msgType":3, "MsgType":3, "url":"http://siyouyunsy-1253559996.cos.ap-guangzhou.myqcloud.com/msg/RRZK2/20200309/8463984522010146526_wxid_lbejkr1i6jl922_1583763617943_.png?sign=q-sign-algorithm%3Dsha1%26q-ak%3DAKIDBi7d3I4UK7iDXkAhQyQsDMNGxY2KmlCY%26q-sign-time%3D1583763618%3B1670077218%26q-key-time%3D1583763618%3B1670077218%26q-header-list%3D%26q-url-param-list%3D%26q-signature%3Dac39f80a894c2e933954553a010c1cd65afb71a1", "content":"<?xml version="1.0"?> <msg> <img aeskey="6670376d31766e3070346f6c65326b32" encryver="0" cdnthumbaeskey="6670376d31766e3070346f6c65326b32" cdnthumburl="30570201000450304e0201000204c740a6e002032f80290204d6833cb702045e6650a10429777875706c6f61645f777869645f6c62656a6b723169366a6c39323231345f313538333736333631360204010818020201000400" cdnthumblength="4681" cdnthumbheight="120" cdnthumbwidth="101" cdnmidheight="0" cdnmidwidth="0" cdnhdheight="0" cdnhdwidth="0" cdnmidimgurl="30570201000450304e0201000204c740a6e002032f80290204d6833cb702045e6650a10429777875706c6f61645f777869645f6c62656a6b723169366a6c39323231345f313538333736333631360204010818020201000400" length="11345" md5="15099d2d8320462b4294439f8fda6c66" /> </msg> ", "uin":"2123131667", "Uin":"2123131667", "msgId":"8463984522010146526", "loginer":1, "Content":"<?xml version="1.0"?> <msg> <img aeskey="6670376d31766e3070346f6c65326b32" encryver="0" cdnthumbaeskey="6670376d31766e3070346f6c65326b32" cdnthumburl="30570201000450304e0201000204c740a6e002032f80290204d6833cb702045e6650a10429777875706c6f61645f777869645f6c62656a6b723169366a6c39323231345f313538333736333631360204010818020201000400" cdnthumblength="4681" cdnthumbheight="120" cdnthumbwidth="101" cdnmidheight="0" cdnmidwidth="0" cdnhdheight="0" cdnhdwidth="0" cdnmidimgurl="30570201000450304e0201000204c740a6e002032f80290204d6833cb702045e6650a10429777875706c6f61645f777869645f6c62656a6b723169366a6c39323231345f313538333736333631360204010818020201000400" length="11345" md5="15099d2d8320462b4294439f8fda6c66" /> </msg> " } ``` > 備注：參數填充參考接收到的消息內容參數 - 返回值示例 ``` { "msg":"發送成功", "code":200 } ``` | Sort | Param | Type | Description | ParamDesc | --- | --- | --- | --- | --- | > ***** 接口描述 | ***發送文本消息*** ---|--- URL | /wechat_api/message/sendMessage 請求方式 | POST 請求參數 | {"uin":"24323538036","msgType":"1","fromUserName":"wxid_1yf4qxydy38b12","toUserName":"12272226587@chatroom","loginer":"2206","tokenId":"sendMsg-1552913364779126","fileName":"wxid_4lr4ahr4iw3122","content":"您好！！！"} 返回值 | {"msg": "上傳文件成功","code": 200} | Sort | Param | Type | required | Description | | --- | --- | --- | --- | --- | | 請求參數 | uin | string | Y | uin | 請求參數 | msgType | int | Y | {1：文本消息} | 請求參數 | fromUserName | string | Y | 發送者微信號 | 請求參數 | toUserName | string | Y | 接收者微信號 | 請求參數 | loginer | int | Y | 登錄人ID | 請求參數 | tokenId | string | Y | 請求序號,sendMsg-14位隨機數 | 請求參數 | fileName | string | N | 需要@人的微信號wxid_4lr4ahr4iw3122 | 請求參數 | MTYPE |string| Y | 發送文本消息固定為sendMessage | 請求參數 | content |string| Y | 發送文本內容 > ***** 接口描述 | ***語音轉文本*** ---|--- URL |/wechat_api/message/voiceToText 請求方式 | GET 請求參數 | {voiceUrl:"string", msgId:"string"} 返回值 | | Sort | Param | Type | required | Description | | --- | --- | --- | --- | --- | | 請求參數 | voiceUrl | string | Y | 語音的url | 請求參數 | msgId| string | Y | 微信官方的msgId > ***** - API infomation 接口描述 | ***文件上傳*** ---|--- URL |/wechat_api/qiniu/getUploadToken 請求方式 | GET 請求參數 | ?key=1578489128776xyU/2.png&&prefix=msg - params infomation | Sort | Param | Type | required | Description | | --- | --- | --- | --- | --- | | 請求參數 | key | string | Y | 用于生成返回文件鏈接的后綴 | 請求參數 | prefix| string | Y | 固定參數 - response example ``` { "code":200, "msg":"操作成功", "data":{ ????????"cred":"{"authorization":"q-sign-algorithm=sha1&q-ak=AKIDYxSB7ObErTJoVEv3gzKw2V5nkc93gv1a&q-sign-time=1578489128;1578489728&q-key-time=1578489128;1578489728&q-header-list=&q-url-param-list=&q-signature=2396f19a8ceebfdf50847bad1f901d690c8b5ea9","bucketName":"siyouyunsy-1253559996","region":"ap-guangzhou","token":"939a5dd9c4868fd01ec8d945ae0ba94619d25f3630001"}", ????????"authKey":"TAOMQ", ????????"host":"[https://siyouyunsy-1253559996.file.myqcloud.com](https://siyouyunsy-1253559996.file.myqcloud.com/)", ????????"isPrivate":1, ????????"type":3, ????????"key":"/msg/TAOMQ/20200108/1578489128776xyU/2.png" ????} } ```