GET
GET = 'get'
Class Session.
$http : \EasyWeChat\Core\Http
Http instance.
$accessToken : \EasyWeChat\Core\AccessToken
The request token.
__construct(\EasyWeChat\Core\AccessToken $accessToken)
Constructor.
\EasyWeChat\Core\AccessToken | $accessToken |
getHttp() : \EasyWeChat\Core\Http
Return the http instance.
setHttp(\EasyWeChat\Core\Http $http) : $this
Set the http instance.
\EasyWeChat\Core\Http | $http |
getAccessToken() : \EasyWeChat\Core\AccessToken
Return the current accessToken.
setAccessToken(\EasyWeChat\Core\AccessToken $accessToken) : $this
Set the request token.
\EasyWeChat\Core\AccessToken | $accessToken |
parseJSON(string $method, array $args) : \EasyWeChat\Support\Collection
Parse JSON from response and check error.
string | $method | |
array | $args |
| null
lists(string $account) : \EasyWeChat\Support\Collection
List all sessions of $account.
string | $account |
waiters() : \EasyWeChat\Support\Collection
List all waiters of $account.
create(string $account, string $openId) : \EasyWeChat\Support\Collection
Create a session.
string | $account | |
string | $openId |
close(string $account, string $openId) : \EasyWeChat\Support\Collection
Close a session.
string | $account | |
string | $openId |
get(string $openId) : \EasyWeChat\Support\Collection
Get a session.
string | $openId |
<?php
/*
* This file is part of the overtrue/wechat.
*
* (c) overtrue <i@overtrue.me>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
/**
* Session.php.
*
* @author overtrue <i@overtrue.me>
* @copyright 2015 overtrue <i@overtrue.me>
*
* @see https://github.com/overtrue
* @see http://overtrue.me
*/
namespace EasyWeChat\Staff;
use EasyWeChat\Core\AbstractAPI;
/**
* Class Session.
*/
class Session extends AbstractAPI
{
const API_CREATE = 'https://api.weixin.qq.com/customservice/kfsession/create';
const API_CLOSE = 'https://api.weixin.qq.com/customservice/kfsession/close';
const API_GET = 'https://api.weixin.qq.com/customservice/kfsession/getsession';
const API_LISTS = 'https://api.weixin.qq.com/customservice/kfsession/getsessionlist';
const API_WAITERS = 'https://api.weixin.qq.com/customservice/kfsession/getwaitcase';
/**
* List all sessions of $account.
*
* @param string $account
*
* @return \EasyWeChat\Support\Collection
*/
public function lists($account)
{
return $this->parseJSON('get', [self::API_LISTS, ['kf_account' => $account]]);
}
/**
* List all waiters of $account.
*
* @return \EasyWeChat\Support\Collection
*/
public function waiters()
{
return $this->parseJSON('get', [self::API_WAITERS]);
}
/**
* Create a session.
*
* @param string $account
* @param string $openId
*
* @return \EasyWeChat\Support\Collection
*/
public function create($account, $openId)
{
$params = [
'kf_account' => $account,
'openid' => $openId,
];
return $this->parseJSON('json', [self::API_CREATE, $params]);
}
/**
* Close a session.
*
* @param string $account
* @param string $openId
*
* @return \EasyWeChat\Support\Collection
*/
public function close($account, $openId)
{
$params = [
'kf_account' => $account,
'openid' => $openId,
];
return $this->parseJSON('json', [self::API_CLOSE, $params]);
}
/**
* Get a session.
*
* @param string $openId
*
* @return \EasyWeChat\Support\Collection
*/
public function get($openId)
{
return $this->parseJSON('get', [self::API_GET, ['openid' => $openId]]);
}
}