W3Cschool
恭喜您成為首批注冊用戶
獲得88經(jīng)驗值獎勵
當(dāng)用戶和公眾號產(chǎn)生特定動作的交互時(具體動作列表請見下方說明),微信將會把消息數(shù)據(jù)推送給開發(fā)者,開發(fā)者可以在一段時間內(nèi)(目前修改為48小時)調(diào)用客服接口,通過POST一個JSON數(shù)據(jù)包來發(fā)送消息給普通用戶。此接口主要用于客服等有人工消息處理環(huán)節(jié)的功能,方便開發(fā)者為用戶提供更加優(yōu)質(zhì)的服務(wù)。
目前允許的動作列表如下(公眾平臺會根據(jù)運(yùn)營情況更新該列表,不同動作觸發(fā)后,允許的客服接口下發(fā)消息條數(shù)不同,下發(fā)條數(shù)達(dá)到上限后,會遇到錯誤返回碼,具體請見返回碼說明頁):
1、用戶發(fā)送信息 2、點(diǎn)擊自定義菜單(僅有點(diǎn)擊推事件、掃碼推事件、掃碼推事件且彈出“消息接收中”提示框這3種菜單類型是會觸發(fā)客服接口的) 3、關(guān)注公眾號 4、掃描二維碼 5、支付成功 6、用戶維權(quán)
為了幫助公眾號使用不同的客服身份服務(wù)不同的用戶群體,客服接口進(jìn)行了升級,開發(fā)者可以管理客服賬號,并設(shè)置客服賬號的頭像和昵稱。該能力針對所有擁有客服接口權(quán)限的公眾號開放。
另外,請開發(fā)者注意,本接口中所有使用到media_id的地方,現(xiàn)在都可以使用素材管理中的永久素材media_id了。
開發(fā)者在根據(jù)開發(fā)文檔的要求完成開發(fā)后,使用6.0.2版及以上版本的微信用戶在與公眾號進(jìn)行客服溝通,公眾號使用不同的客服賬號進(jìn)行回復(fù)后,用戶可以看到對應(yīng)的客服頭像和昵稱。
請注意,必須先在公眾平臺官網(wǎng)為公眾號設(shè)置微信號后才能使用該能力。
開發(fā)者可以通過本接口為公眾號添加客服賬號,每個公眾號最多添加10個客服賬號。該接口調(diào)用請求如下:
http請求方式: POST https://api.weixin.qq.com/customservice/kfaccount/add?access_token=ACCESS_TOKEN
POST數(shù)據(jù)示例如下:
{ "kf_account" : "test1@test", "nickname" : "客服1", "password" : "pswmd5", }
返回說明(正確時的JSON返回結(jié)果):
{ "errcode" : 0, "errmsg" : "ok", }
錯誤時微信會返回錯誤碼等信息,請根據(jù)錯誤碼查詢錯誤信息
開發(fā)者可以通過本接口為公眾號修改客服賬號。該接口調(diào)用請求如下:
http請求方式: POST https://api.weixin.qq.com/customservice/kfaccount/update?access_token=ACCESS_TOKEN
POST數(shù)據(jù)示例如下:
{ "kf_account" : "test1@test", "nickname" : "客服1", "password" : "pswmd5", }
返回說明(正確時的JSON返回結(jié)果):
{ "errcode" : 0, "errmsg" : "ok", }
錯誤時微信會返回錯誤碼等信息,請根據(jù)錯誤碼查詢錯誤信息
開發(fā)者可以通過該接口為公眾號刪除客服帳號。該接口調(diào)用請求如下:
http請求方式: GET https://api.weixin.qq.com/customservice/kfaccount/del?access_token=ACCESS_TOKEN
POST數(shù)據(jù)示例如下:
{ "kf_account" : "test1@test", "nickname" : "客服1", "password" : "pswmd5", }
返回說明(正確時的JSON返回結(jié)果):
{ "errcode" : 0, "errmsg" : "ok", }
錯誤時微信會返回錯誤碼等信息,請根據(jù)錯誤碼查詢錯誤信息
開發(fā)者可調(diào)用本接口來上傳圖片作為客服人員的頭像,頭像圖片文件必須是jpg格式,推薦使用640*640大小的圖片以達(dá)到最佳效果。該接口調(diào)用請求如下:
http請求方式: POST/FORM http://api.weixin.qq.com/customservice/kfaccount/uploadheadimg?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT 調(diào)用示例:使用curl命令,用FORM表單方式上傳一個多媒體文件,curl命令的具體用法請自行了解
返回說明(正確時的JSON返回結(jié)果):
{ "errcode" : 0, "errmsg" : "ok", }
錯誤時微信會返回錯誤碼等信息,請根據(jù)錯誤碼查詢錯誤信息
開發(fā)者通過本接口,獲取公眾號中所設(shè)置的客服基本信息,包括客服工號、客服昵稱、客服登錄賬號。
http請求方式: GET https://api.weixin.qq.com/cgi-bin/customservice/getkflist?access_token=ACCESS_TOKEN
返回說明(正確時的JSON返回結(jié)果):
{ "kf_list": [ { "kf_account": "test1@test", "kf_nick": "ntest1", "kf_id": "1001" "kf_headimgurl": " http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw/0" }, { "kf_account": "test2@test", "kf_nick": "ntest2", "kf_id": "1002" "kf_headimgurl": " http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw /0" }, { "kf_account": "test3@test", "kf_nick": "ntest3", "kf_id": "1003" "kf_headimgurl": " http://mmbiz.qpic.cn/mmbiz/4whpV1VZl2iccsvYbHvnphkyGtnvjfUS8Ym0GSaLic0FD3vN0V8PILcibEGb2fPfEOmw /0" } ] }
錯誤時微信會返回錯誤碼等信息,請根據(jù)錯誤碼查詢錯誤信息
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
kf_account | 是 | 完整客服賬號,格式為:賬號前綴@公眾號微信號 |
kf_nick | 是 | 客服昵稱 |
kf_id | 是 | 客服工號 |
nickname | 是 | 客服昵稱,最長6個漢字或12個英文字符 |
password | 否 | 客服賬號登錄密碼,格式為密碼明文的32位加密MD5值。該密碼僅用于在公眾平臺官網(wǎng)的多客服功能中使用,若不使用多客服功能,則不必設(shè)置密碼 |
media | 是 | 該參數(shù)僅在設(shè)置客服頭像時出現(xiàn),是form-data中媒體文件標(biāo)識,有filename、filelength、content-type等信息 |
接口調(diào)用請求說明
http請求方式: POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
各消息類型所需的JSON數(shù)據(jù)包如下:
發(fā)送文本消息
{ "touser":"OPENID", "msgtype":"text", "text": { "content":"Hello World" } }
發(fā)送圖片消息
{ "touser":"OPENID", "msgtype":"image", "image": { "media_id":"MEDIA_ID" } }
發(fā)送語音消息
{ "touser":"OPENID", "msgtype":"voice", "voice": { "media_id":"MEDIA_ID" } }
發(fā)送視頻消息
{ "touser":"OPENID", "msgtype":"video", "video": { "media_id":"MEDIA_ID", "thumb_media_id":"MEDIA_ID", "title":"TITLE", "description":"DESCRIPTION" } }
發(fā)送音樂消息
{ "touser":"OPENID", "msgtype":"music", "music": { "title":"MUSIC_TITLE", "description":"MUSIC_DESCRIPTION", "musicurl":"MUSIC_URL", "hqmusicurl":"HQ_MUSIC_URL", "thumb_media_id":"THUMB_MEDIA_ID" } }
發(fā)送圖文消息(點(diǎn)擊跳轉(zhuǎn)到外鏈) 圖文消息條數(shù)限制在8條以內(nèi),注意,如果圖文數(shù)超過8,則將會無響應(yīng)。
{ "touser":"OPENID", "msgtype":"news", "news":{ "articles": [ { "title":"Happy Day", "description":"Is Really A Happy Day", "url":"URL", "picurl":"PIC_URL" }, { "title":"Happy Day", "description":"Is Really A Happy Day", "url":"URL", "picurl":"PIC_URL" } ] } }
發(fā)送圖文消息(點(diǎn)擊跳轉(zhuǎn)到圖文消息頁面) 圖文消息條數(shù)限制在8條以內(nèi),注意,如果圖文數(shù)超過8,則將會無響應(yīng)。
{ "touser":"OPENID", "msgtype":"mpnews", "mpnews": { "media_id":"MEDIA_ID" } }
發(fā)送卡券
{ "touser":"OPENID", "msgtype":"wxcard", "wxcard":{ "card_id":"123dsdajkasd231jhksad" }, }
特別注意客服消息接口投放卡券僅支持非自定義Code碼和導(dǎo)入code模式的卡券的卡券。
請注意,如果需要以某個客服帳號來發(fā)消息(在微信6.0.2及以上版本中顯示自定義頭像),則需在JSON數(shù)據(jù)包的后半部分加入customservice參數(shù),例如發(fā)送文本消息則改為:
{ "touser":"OPENID", "msgtype":"text", "text": { "content":"Hello World" }, "customservice": { "kf_account": "test1@kftest" } }
參數(shù) | 是否必須 | 說明 |
---|---|---|
access_token | 是 | 調(diào)用接口憑證 |
touser | 是 | 普通用戶openid |
msgtype | 是 | 消息類型,文本為text,圖片為image,語音為voice,視頻消息為video,音樂消息為music,圖文消息(點(diǎn)擊跳轉(zhuǎn)到外鏈)為news,圖文消息(點(diǎn)擊跳轉(zhuǎn)到圖文消息頁面)為mpnews,卡券為wxcard |
content | 是 | 文本消息內(nèi)容 |
media_id | 是 | 發(fā)送的圖片/語音/視頻/圖文消息(點(diǎn)擊跳轉(zhuǎn)到圖文消息頁)的媒體ID |
thumb_media_id | 是 | 縮略圖的媒體ID |
title | 否 | 圖文消息/視頻消息/音樂消息的標(biāo)題 |
description | 否 | 圖文消息/視頻消息/音樂消息的描述 |
musicurl | 是 | 音樂鏈接 |
hqmusicurl | 是 | 高品質(zhì)音樂鏈接,wifi環(huán)境優(yōu)先使用該鏈接播放音樂 |
url | 否 | 圖文消息被點(diǎn)擊后跳轉(zhuǎn)的鏈接 |
picurl | 否 | 圖文消息的圖片鏈接,支持JPG、PNG格式,較好的效果為大圖640*320,小圖80*80 |
接口返回說明
返回數(shù)據(jù)示例(正確時的JSON返回結(jié)果):
Copyright©2021 w3cschool編程獅|閩ICP備15016281號-3|閩公網(wǎng)安備35020302033924號
違法和不良信息舉報電話:173-0602-2364|舉報郵箱:jubao@eeedong.com
掃描二維碼
下載編程獅App
編程獅公眾號
聯(lián)系方式:
更多建議: