wx-finance-sdk/README.md

80 lines
2.1 KiB
Markdown
Raw Normal View History

2020-02-20 21:25:49 +08:00
# wxwork_finance_sdk_wrapper
2020-02-29 13:26:54 +08:00
企业微信-获取会话内容PHP扩展
## 依赖
企业微信提供的sdk;
PHP VERSION >= 7.0
## 安装步骤及要求
2020-02-29 13:31:41 +08:00
```
$INSATLL_PATH_PATH/bin/phpize
2020-02-29 13:26:54 +08:00
2020-02-29 13:31:41 +08:00
./configure --with-php-config=$INSTALL_PHP_PATH/php-config --with-wxwork_finance_sdk=$WXWORK_FINANCE_C_SDK_PATH
2020-02-29 13:26:54 +08:00
make && make install
2020-02-29 13:31:41 +08:00
```
2020-02-29 13:26:54 +08:00
php.ini 增加 extension=wxwork_finance_sdk.so
2020-02-29 13:31:41 +08:00
## API
```php
2020-02-29 13:26:54 +08:00
WxworkFinanceSdkExcption::__construct();
```
```php
WxworkFinanceSdk::__construct(string $corpId, string $secret, array $options);
string $corpId 企业号
string $secret 秘钥
array $options = [ // 可选参数
'proxy_host' => string,
'proxy_password' => string,
'timeout' => 10, // 默认超时时间为10s
]
```
```php
string WxworkFinanceSdk::getChatData(int $seq, int $limit);
* 拉取聊天数据
$seq 起始位置
$limit 获取条数
```
```php
array WxworkFinanceSdk::getMediaData(string $fileId, string $indexBuf = '')
* 拉取媒体消息
$filedId 从GetChatData返回的聊天消息中媒体消息包括的sdkfileid
$indexBuf 下一次拉取记录
返回结构:
[
'data' => '媒体内容',
'nextIndex' => '下一次拉取记录',
'isFininshed' => bool // true 数据已全部拉取完毕
]
```
## 示例
2020-02-29 13:30:18 +08:00
```php
2020-02-29 13:26:54 +08:00
$sdk = new WxworkFinanceSdk("wwd08coe7d775abaaa", "zJ6k0naVVQ--gt9PUSSEvs03zW_nlDVmjAkPOTAfrew", [
"proxy_host" => "hello", // 代理地址
"proxy_password" => "world", // 代理密码
"timeout" => 100, // 超时时间
]);
var_dump(json_decode($sdk->getChatData(0, 100)));
/**
return [
'data' => string // 返回的数据,
'nextIndex' => string // 下一个指针,
'isFinished' => bool // 是否继续获取 下一条数据标识
];
*/
var_dump($sdk->getMediaData("dddd"));
2020-02-29 13:31:41 +08:00
```
2020-02-29 13:26:54 +08:00