\Chatopera\SDKChatbot

Class Chatbot 企业聊天机器人

Summary

Methods

Properties

Constants

__construct()
detail()
conversation()
faq()
users()
chats()
mute()
unmute()
ismute()
user()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

generate()
purge()

$baseUrl
$clientId
$clientSecret

N/A

File: Chatbot.php
Package: Chatopera\SDK
Class hierarchy: \Chatopera\SDK\Chatbot

Properties

$baseUrl

$baseUrl :

Type

$clientId

$clientId :

Type

$clientSecret

$clientSecret :

Type

Methods

__construct()

__construct(  $clientId,   $clientSecret)

Chatbot constructor.

Parameters

	$clientId	机器人 ClientId
	$clientSecret	机器人 Secret

detail()

detail() : mixed

查看机器人详情

Throws

\Exception

Returns

mixed

conversation()

conversation(  $userId,   $textMessage) : mixed

检索多轮对话

Parameters

	$userId	用户唯一标识
	$textMessage	问题

Throws

\Exception

Returns

mixed

faq()

faq(  $userId,   $query) : mixed

检索机器人知识库

Parameters

	$userId	用户唯一标识
	$query	问题

Throws

\Exception

Returns

mixed

users()

users(integer  $limit = 50, integer  $page = 1, string  $sortby = "-lasttime") : mixed

查询用户列表

Parameters

integer	$limit	每页数据条数
integer	$page	页面索引
string	$sortby	排序规则

Throws

\Exception

Returns

mixed

chats()

chats(  $userId, integer  $limit = 50, integer  $page = 1, string  $sortby = '-lasttime') : mixed

查看一个用户的聊天历史

Parameters

	$userId	用户唯一标识
integer	$limit	每页数据条数
integer	$page	页面索引
string	$sortby	排序规则[-lasttime: 最后对话时间降序]

Throws

\Exception

Returns

mixed

mute()

mute(  $userId) : boolean

屏蔽用户

Parameters

$userId

用户唯一标识

Throws

\Exception

Returns

boolean —

执行是否成功

unmute()

unmute(  $userId) : boolean

取消屏蔽用户

Parameters

$userId

用户唯一标识

Throws

\Exception

Returns

boolean —

执行是否成功

ismute()

ismute(  $userId) : boolean

检测用户是否被屏蔽

Parameters

$userId

用户唯一标识

Throws

\Exception

Returns

boolean —

用户是否被屏蔽

user()

user(  $userId) : mixed

读取用户画像

Parameters

$userId

用户唯一标识

Throws

\Exception

Returns

mixed

generate()

generate(  $clientId,   $secret,   $method,   $path) : string

认证签名算法

Parameters

	$clientId
	$secret
	$method
	$path

Returns

string

purge()

purge(  $resp) : mixed

删除内部ID

Parameters

$resp

Returns

mixed