ppagent / IWeWorkSourceOptions

Interface: IWeWorkSourceOptions

Defined in: src/source/wework.source.ts:175

一个source可以有多个实例，比如不同的api地址，由用户配置

Extends

• ISourceOptions

Properties

aesKey?

optional aesKey: string

Defined in: src/source/wework.source.ts:180

---

agentId?

optional agentId: string

Defined in: src/source/wework.source.ts:176

---

apiHost?

optional apiHost: string

Defined in: src/source/wework.source.ts:181

---

appChatGroups?

optional appChatGroups: object[]

Defined in: src/source/wework.source.ts:209

需要该应用自动创建的群聊。由于只有应用创建的群聊才能够主动推送群消息，因此需要先创建群聊。

注意务必指定群聊的ID，以便后续发消息时进行引用。

如果已经存在的群聊会提示重复，不影响。

chatid

chatid: string

群聊ID

name

name: string

群名称

userlist

userlist: string[]

第一个人是群主

---

autoReLogin?

optional autoReLogin: boolean

Defined in: src/source/source.ts:15

离线后是否自动重新请求登陆，默认false

Inherited from

ISourceOptions.autoReLogin

---

corpId?

optional corpId: string

Defined in: src/source/wework.source.ts:178

---

instanceName?

optional instanceName: string

Defined in: src/instance.base.manager.ts:10

用来区分不同实例的全局唯一key

Inherited from

ISourceOptions.instanceName

---

manualKeyWords?

optional manualKeyWords: string[]

Defined in: src/source/wework.source.ts:187

转人工关键词列表，默认为 ["人工"]，即只要消息中包含了这个关键词，就会将客服状态转为人工接管。暂未启用。

前提是配置了人工接待账号

---

manualUsers?

optional manualUsers: string[]

Defined in: src/source/wework.source.ts:191

接待人员列表。目前策略为随机选择一个接待人员（还是放入接待池？）暂未启用。

---

secret?

optional secret: string

Defined in: src/source/wework.source.ts:177

---

token?

optional token: string

Defined in: src/source/wework.source.ts:179

---

welcomeInKfMode?

optional welcomeInKfMode: boolean

Defined in: src/source/wework.source.ts:197

客服模式下，用户第一次进入时是否发送欢迎语，如果是的话，可以通过设置prompt让bot生成一段欢迎的话。

默认false

---

welcomePrompt?

optional welcomePrompt: string

Defined in: src/source/wework.source.ts:201

欢迎词的提示语,可以使用{nickName}对用户的昵称进行占位，如果提示语以双下划线开头，则会直接发送这段话，注意这时将不经过agent。如：__欢迎{nickName}，有任何问题都可以跟我咨询。