From 81a7030cfe4f1271fe81aadb7d3477db8aa3f80c Mon Sep 17 00:00:00 2001 From: yangfan Date: Mon, 14 Feb 2022 19:26:35 +0800 Subject: [PATCH] Modify the file encoding to UTF-8 --- lib/WeWorkFinanceSdk_C.h | 126 +++++++++++++++++++-------------------- 1 file changed, 63 insertions(+), 63 deletions(-) diff --git a/lib/WeWorkFinanceSdk_C.h b/lib/WeWorkFinanceSdk_C.h index 27c4bc7..c6c66cb 100644 --- a/lib/WeWorkFinanceSdk_C.h +++ b/lib/WeWorkFinanceSdk_C.h @@ -1,25 +1,25 @@ // All Rights Reserved. -// *File ： WeWorkFinanceSdk_C.h -// @Brief：拉取企业聊天记录与媒体消息sdk头文件 +// *File 锛 WeWorkFinanceSdk_C.h +// @Brief锛氭媺鍙栦紒涓氳亰澶╄褰曚笌濯掍綋娑堟伅sdk澶存枃浠 #pragma once -//返回码 错误说明 -//10000 参数错误，请求参数错误 -//10001 网络错误，网络请求错误 -//10002 数据解析失败 -//10003 系统失败 -//10004 密钥错误导致加密失败 -//10005 fileid错误 -//10006 解密失败 -//10007 找不到消息加密版本的私钥，需要重新传入私钥对 -//10008 解析encrypt_key出错 -//10009 ip非法 -//10010 数据过期 -//10011 证书错误 +//杩斿洖鐮 閿欒璇存槑 +//10000 鍙傛暟閿欒锛岃姹傚弬鏁伴敊璇 +//10001 缃戠粶閿欒锛岀綉缁滆姹傞敊璇 +//10002 鏁版嵁瑙ｆ瀽澶辫触 +//10003 绯荤粺澶辫触 +//10004 瀵嗛挜閿欒瀵艰嚧鍔犲瘑澶辫触 +//10005 fileid閿欒 +//10006 瑙ｅ瘑澶辫触 +//10007 鎵句笉鍒版秷鎭姞瀵嗙増鏈殑绉侀挜锛岄渶瑕侀噸鏂颁紶鍏ョ閽ュ +//10008 瑙ｆ瀽encrypt_key鍑洪敊 +//10009 ip闈炴硶 +//10010 鏁版嵁杩囨湡 +//10011 璇佷功閿欒 typedef struct WeWorkFinanceSdk_t WeWorkFinanceSdk_t; -// 数据 +// 鏁版嵁 typedef struct Slice_t { char* buf; int len; @@ -42,100 +42,100 @@ extern "C" { /** - * 初始化函数 - * Return值=0表示该API调用成功 + * 鍒濆鍖栧嚱鏁 + * Return鍊=0琛ㄧず璇PI璋冪敤鎴愬姛 * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] corpid 调用企业的企业id，例如：wwd08c8exxxx5ab44d，可以在企业微信管理端--我的企业--企业信息查看 - * @param [in] secret 聊天内容存档的Secret，可以在企业微信管理端--管理工具--聊天内容存档查看 + * @param [in] sdk NewSdk杩斿洖鐨剆dk鎸囬拡 + * @param [in] corpid 璋冪敤浼佷笟鐨勪紒涓歩d锛屼緥濡傦細wwd08c8exxxx5ab44d锛屽彲浠ュ湪浼佷笟寰俊绠＄悊绔--鎴戠殑浼佷笟--浼佷笟淇℃伅鏌ョ湅 + * @param [in] secret 鑱婂ぉ鍐呭瀛樻。鐨凷ecret锛屽彲浠ュ湪浼佷笟寰俊绠＄悊绔--绠＄悊宸ュ叿--鑱婂ぉ鍐呭瀛樻。鏌ョ湅 * * - * @return 返回是否初始化成功 - * 0 - 成功 - * !=0 - 失败 + * @return 杩斿洖鏄惁鍒濆鍖栨垚鍔 + * 0 - 鎴愬姛 + * !=0 - 澶辫触 */ int Init(WeWorkFinanceSdk_t* sdk, const char* corpid, const char* secret); /** - * 拉取聊天记录函数 - * Return值=0表示该API调用成功 + * 鎷夊彇鑱婂ぉ璁板綍鍑芥暟 + * Return鍊=0琛ㄧず璇PI璋冪敤鎴愬姛 * * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] seq 从指定的seq开始拉取消息，注意的是返回的消息从seq+1开始返回，seq为之前接口返回的最大seq值。首次使用请使用seq:0 - * @param [in] limit 一次拉取的消息条数，最大值1000条，超过1000条会返回错误 - * @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 - * @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 - * @param [in] timeout 超时时间，单位秒 - * @param [out] chatDatas 返回本次拉取消息的数据，slice结构体.内容包括errcode/errmsg，以及每条消息内容。示例如下： + * @param [in] sdk NewSdk杩斿洖鐨剆dk鎸囬拡 + * @param [in] seq 浠庢寚瀹氱殑seq寮濮嬫媺鍙栨秷鎭紝娉ㄦ剰鐨勬槸杩斿洖鐨勬秷鎭粠seq+1寮濮嬭繑鍥烇紝seq涓轰箣鍓嶆帴鍙ｈ繑鍥炵殑鏈澶eq鍊笺傞娆′娇鐢ㄨ浣跨敤seq:0 + * @param [in] limit 涓娆℃媺鍙栫殑娑堟伅鏉℃暟锛屾渶澶у1000鏉★紝瓒呰繃1000鏉′細杩斿洖閿欒 + * @param [in] proxy 浣跨敤浠ｇ悊鐨勮姹傦紝闇瑕佷紶鍏ヤ唬鐞嗙殑閾炬帴銆傚锛歴ocks5://10.0.0.1:8081 鎴栬 http://10.0.0.1:8081 + * @param [in] passwd 浠ｇ悊璐﹀彿瀵嗙爜锛岄渶瑕佷紶鍏ヤ唬鐞嗙殑璐﹀彿瀵嗙爜銆傚 user_name:passwd_123 + * @param [in] timeout 瓒呮椂鏃堕棿锛屽崟浣嶇 + * @param [out] chatDatas 杩斿洖鏈鎷夊彇娑堟伅鐨勬暟鎹紝slice缁撴瀯浣.鍐呭鍖呮嫭errcode/errmsg锛屼互鍙婃瘡鏉℃秷鎭唴瀹广傜ず渚嬪涓嬶細 {"errcode":0,"errmsg":"ok","chatdata":[{"seq":196,"msgid":"CAQQ2fbb4QUY0On2rYSAgAMgip/yzgs=","publickey_ver":3,"encrypt_random_key":"ftJ+uz3n/z1DsxlkwxNgE+mL38H42/KCvN8T60gbbtPD+Rta1hKTuQPzUzO6Hzne97MgKs7FfdDxDck/v8cDT6gUVjA2tZ/M7euSD0L66opJ/IUeBtpAtvgVSD5qhlaQjvfKJc/zPMGNK2xCLFYqwmQBZXbNT7uA69Fflm512nZKW/piK2RKdYJhRyvQnA1ISxK097sp9WlEgDg250fM5tgwMjujdzr7ehK6gtVBUFldNSJS7ndtIf6aSBfaLktZgwHZ57ONewWq8GJe7WwQf1hwcDbCh7YMG8nsweEwhDfUz+u8rz9an+0lgrYMZFRHnmzjgmLwrR7B/32Qxqd79A==","encrypt_chat_msg":"898WSfGMnIeytTsea7Rc0WsOocs0bIAerF6de0v2cFwqo9uOxrW9wYe5rCjCHHH5bDrNvLxBE/xOoFfcwOTYX0HQxTJaH0ES9OHDZ61p8gcbfGdJKnq2UU4tAEgGb8H+Q9n8syRXIjaI3KuVCqGIi4QGHFmxWenPFfjF/vRuPd0EpzUNwmqfUxLBWLpGhv+dLnqiEOBW41Zdc0OO0St6E+JeIeHlRZAR+E13Isv9eS09xNbF0qQXWIyNUi+ucLr5VuZnPGXBrSfvwX8f0QebTwpy1tT2zvQiMM2MBugKH6NuMzzuvEsXeD+6+3VRqL"}]} * - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 + * @return 杩斿洖鏄惁璋冪敤鎴愬姛 + * 0 - 鎴愬姛 + * !=0 - 澶辫触 */ int GetChatData(WeWorkFinanceSdk_t* sdk, unsigned long long seq, unsigned int limit, const char *proxy,const char* passwd, int timeout,Slice_t* chatDatas); /** - * @brief 解析密文.企业微信自有解密内容 - * @param [in] encrypt_key, getchatdata返回的encrypt_random_key,使用企业自持对应版本秘钥RSA解密后的内容 - * @param [in] encrypt_msg, getchatdata返回的encrypt_chat_msg - * @param [out] msg, 解密的消息明文 - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 + * @brief 瑙ｆ瀽瀵嗘枃.浼佷笟寰俊鑷湁瑙ｅ瘑鍐呭 + * @param [in] encrypt_key, getchatdata杩斿洖鐨別ncrypt_random_key,浣跨敤浼佷笟鑷寔瀵瑰簲鐗堟湰绉橀挜RSA瑙ｅ瘑鍚庣殑鍐呭 + * @param [in] encrypt_msg, getchatdata杩斿洖鐨別ncrypt_chat_msg + * @param [out] msg, 瑙ｅ瘑鐨勬秷鎭槑鏂 + * @return 杩斿洖鏄惁璋冪敤鎴愬姛 + * 0 - 鎴愬姛 + * !=0 - 澶辫触 */ int DecryptData(const char* encrypt_key, const char* encrypt_msg, Slice_t* msg); /** - * 拉取媒体消息函数 - * Return值=0表示该API调用成功 + * 鎷夊彇濯掍綋娑堟伅鍑芥暟 + * Return鍊=0琛ㄧず璇PI璋冪敤鎴愬姛 * * - * @param [in] sdk NewSdk返回的sdk指针 - * @param [in] sdkFileid 从GetChatData返回的聊天消息中，媒体消息包括的sdkfileid - * @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 - * @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 - * @param [in] indexbuf 媒体消息分片拉取，需要填入每次拉取的索引信息。首次不需要填写，默认拉取512k，后续每次调用只需要将上次调用返回的outindexbuf填入即可。 - * @param [in] timeout 超时时间，单位秒 - * @param [out] media_data 返回本次拉取的媒体数据.MediaData结构体.内容包括data(数据内容)/outindexbuf(下次索引)/is_finish(拉取完成标记) + * @param [in] sdk NewSdk杩斿洖鐨剆dk鎸囬拡 + * @param [in] sdkFileid 浠嶨etChatData杩斿洖鐨勮亰澶╂秷鎭腑锛屽獟浣撴秷鎭寘鎷殑sdkfileid + * @param [in] proxy 浣跨敤浠ｇ悊鐨勮姹傦紝闇瑕佷紶鍏ヤ唬鐞嗙殑閾炬帴銆傚锛歴ocks5://10.0.0.1:8081 鎴栬 http://10.0.0.1:8081 + * @param [in] passwd 浠ｇ悊璐﹀彿瀵嗙爜锛岄渶瑕佷紶鍏ヤ唬鐞嗙殑璐﹀彿瀵嗙爜銆傚 user_name:passwd_123 + * @param [in] indexbuf 濯掍綋娑堟伅鍒嗙墖鎷夊彇锛岄渶瑕佸～鍏ユ瘡娆℃媺鍙栫殑绱㈠紩淇℃伅銆傞娆′笉闇瑕佸～鍐欙紝榛樿鎷夊彇512k锛屽悗缁瘡娆¤皟鐢ㄥ彧闇瑕佸皢涓婃璋冪敤杩斿洖鐨刼utindexbuf濉叆鍗冲彲銆 + * @param [in] timeout 瓒呮椂鏃堕棿锛屽崟浣嶇 + * @param [out] media_data 杩斿洖鏈鎷夊彇鐨勫獟浣撴暟鎹.MediaData缁撴瀯浣.鍐呭鍖呮嫭data(鏁版嵁鍐呭)/outindexbuf(涓嬫绱㈠紩)/is_finish(鎷夊彇瀹屾垚鏍囪) * - * @return 返回是否调用成功 - * 0 - 成功 - * !=0 - 失败 + * @return 杩斿洖鏄惁璋冪敤鎴愬姛 + * 0 - 鎴愬姛 + * !=0 - 澶辫触 */ int GetMediaData(WeWorkFinanceSdk_t* sdk, const char* indexbuf, const char* sdkFileid,const char *proxy,const char* passwd, int timeout, MediaData_t* media_data); /** - * @brief 释放sdk，和NewSdk成对使用 + * @brief 閲婃斁sdk锛屽拰NewSdk鎴愬浣跨敤 * @return */ void DestroySdk(WeWorkFinanceSdk_t* sdk); - //--------------下面接口为了其他语言例如python等调用c接口，酌情使用-------------- + //--------------涓嬮潰鎺ュ彛涓轰簡鍏朵粬璇█渚嬪python绛夎皟鐢╟鎺ュ彛锛岄厡鎯呬娇鐢-------------- Slice_t* NewSlice(); /** - * @brief 释放slice，和NewSlice成对使用 + * @brief 閲婃斁slice锛屽拰NewSlice鎴愬浣跨敤 * @return */ void FreeSlice(Slice_t* slice); /** - * @brief 为其他语言提供读取接口 - * @return 返回buf指针 - * !=NULL - 成功 - * NULL - 失败 + * @brief 涓哄叾浠栬瑷鎻愪緵璇诲彇鎺ュ彛 + * @return 杩斿洖buf鎸囬拡 + * !=NULL - 鎴愬姛 + * NULL - 澶辫触 */ char* GetContentFromSlice(Slice_t* slice); int GetSliceLen(Slice_t* slice); - // 媒体记录相关工具 + // 濯掍綋璁板綍鐩稿叧宸ュ叿 MediaData_t* NewMediaData();