一、介面簡要介紹
企微介面文檔是企業微信提供給開發者使用的API介面文檔。其主要功能包括:發送應用消息、上傳臨時素材、獲取應用可見範圍等。企微介面文檔支持RESTful和Websoket兩種協議,能夠滿足大部分的業務需求。下面我們來介紹一下企微介面文檔的使用方法。
二、使用流程
企微介面文檔的使用流程如下:
1、創建應用,獲取應用ID和應用密鑰。
/** * 應用ID * @type {string} */ const appid = 'xxxxxxxxxxxxxxxxx'; /** * 應用密鑰 * @type {string} */ const appsecret = 'xxxxxxxxxxxxxxxxx';
2、獲取access_token。
/** * 獲取access_token * @param {string} appid - 應用ID * @param {string} appsecret - 應用密鑰 * @returns {Promise} access_token */ async function getAccessToken(appid, appsecret) { const url = `https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=${appid}&corpsecret=${appsecret}`; const response = await fetch(url); const result = await response.json(); return result.access_token; }
3、發送消息。
/** * 發送消息 * @param {string} access_token - access_token * @param {object} message - 消息體 */ async function sendMessage(access_token, message) { const url = `https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=${access_token}`; const options = { method: 'POST', headers: { 'Content-Type': 'application/json', }, body: JSON.stringify(message), }; await fetch(url, options); }
4、上傳臨時素材。
/** * 上傳臨時素材 * @param {string} access_token - access_token * @param {string} type - 媒體文件類型,分別有圖片(image)、語音(voice)和文件(file) * @param {string} filename - 文件名 * @param {Buffer} buffer - 文件二進位數據 * @returns {Promise
5、獲取應用可見範圍。
/** * 獲取應用可見範圍 * @param {string} access_token - access_token * @returns {Promise
三、注意事項
在使用企微介面文檔時,需要注意以下幾個事項:
1、企微介面需要企業微信管理員授權後才能使用。
2、上傳臨時素材有大小限制。
3、發送消息需要按照企微介面文檔提供的格式進行消息體的構造。
4、獲取應用可見範圍需要獲取應用的agentid。
總而言之,企微介面文檔提供了豐富的功能,可以滿足開發者的大部分需求。開發者在使用時需要按照文檔規範進行操作,注意相關的事項,以保證介面的正確使用。
原創文章,作者:小藍,如若轉載,請註明出處:https://www.506064.com/zh-tw/n/254873.html