触发器
您可以使用API来获取或设置触发器信息。
JSON格式
触发器被表示为具有以下属性的JSON对象:
的名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
描述 | 字符串 | 假 | 假 | 触发器的描述 |
启用 | 整数 | 假 | 假 | 是否启用触发器 |
id | 整数 | 真正的 | 假 | 触发器ID |
的名字 | 字符串 | 假 | 假 | 触发器的名称 |
例子
{
“描述”:“访客进入页面”,
“启用”:1,
“id”:4,
“名称”:“触发”好
}
列表触发器
GET / api / v2 /触发器
列出帐户的触发器。
允许
- 管理员
使用旋度
卷曲https://www.zopim.com/api/v2/triggers \
-v -u {email_address}:{password}
示例响应(年代)
200好了
状态200 OK
[
{
"description": "访问者进入页面",
“启用”:1、
“id”:4
"name": "Good Trigger"
},
{
"description": "访客要求聊天",
“启用”:1、
“id”:5
"name": "Better Trigger"
}
]
显示触发
GET / api / v2 /触发/ {trigger_name}
通过指定触发器名称返回触发器信息。
允许
- 管理员
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
trigger_name | 字符串 | 路径 | 真正的 | 触发器的名称 |
使用旋度
卷曲https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password}
示例响应(年代)
200好了
状态200 OK
{
"description": "访问者进入页面",
“启用”:1、
“id”:4
"name": "Good Trigger"
}
创建触发器
POST / api / v2 /触发器
向帐户添加触发器。
允许
- 管理员
使用旋度
卷曲https://www.zopim.com/api/v2/triggers \
- d”{
"name": "Good Trigger",
"enabled": 1,
"description": "访客要求聊天"
} ' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type: application/json"
示例响应(年代)
201年创建
状态201已创建
{
"description": "访客要求聊天",
“启用”:1、
“id”:4
"name": "Good Trigger"
}
更新触发器
把/ api / v2 /触发/ {trigger_name}
更新触发器的数据。
允许
- 管理员
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
trigger_name | 字符串 | 路径 | 真正的 | 触发器的名称 |
使用旋度
卷曲https://www.zopim.com/api/v2/triggers/{trigger_name} \
- d”{
"name": "Best Trigger",
"description": "访客要求新的聊天"
} ' \
-v -u {email_address}:{password} \
-X PUT -H "Content-Type: application/json"
示例响应(年代)
200好了
状态200 OK
{
"description": "访问者要求新的聊天",
“启用”:1、
“id”:4
"name": "Best Trigger"
}
删除触发器
删除/ api / v2 /触发/ {trigger_name}
删除触发器。
允许
- 管理员
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
trigger_name | 字符串 | 路径 | 真正的 | 触发器的名称 |
使用旋度
卷曲https://www.zopim.com/api/v2/triggers/{trigger_name} \
-v -u {email_address}:{password} -X DELETE
示例响应(年代)
204无内容
204无内容