游客
您可以使用API来获取或设置访问者信息。
JSON格式
访问者被表示为具有以下属性的JSON对象:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| 禁止 | 布尔 | 假 | 假 | 访客目前是否被禁止访问 |
| 创建 | 字符串 | 假 | 假 | 访问者的创建日期 |
| 电子邮件 | 字符串 | 假 | 假 | 访客的电子邮件ID |
| external_id | 字符串 | 真正的 | 假 | 访问者的外部ID |
| id | 整数 | 真正的 | 假 | 访客的ID |
| 名字 | 字符串 | 假 | 假 | 要显示给访问者的名称 |
| 笔记 | 字符串 | 真正的 | 假 | 关于来访者的任何其他说明 |
| 电话 | 字符串 | 假 | 假 | 访客的电话号码(如有) |
例子
{“禁止”：假，“创建”：“2014 - 09 - 01 - t10:29:59z”，“电子邮件”：＂(电子邮件保护)＂，“external_id”：“john_extid”，“id”：1，“名称”：“游客1”，“笔记”：“这个来访者真的很酷。”，“电话”：“12345678 + 65”}
创建访客
POST / api / v2 /访客
允许帐户所有者/管理员添加更多访问者
允许
- 管理员
使用旋度
旋度https://www.zopim.com/api/v2/visitors \- d”{“name”:“访客1”，“电子邮件”:“(电子邮件保护)"，注释:“这个来访者真酷。”“电话”:“+65 12345678”} ' \-v -u {email_address}:{password} \-X POST -H "Content-Type: application/json"
示例响应(年代)
201年创建
状态201已创建{“禁”:假的,“创建”:“2014 - 09 - 01 t10:29:59z”,“电子邮件”:“(电子邮件保护)"，:“external_id john_extid”,“id”:1、“name”:“访客1”，注释:“这个来访者真酷。”“电话”:“+65 12345678”}
显示访客
GET / api / v2 /访客/ {visitor_id}
通过访问者ID获取访问者
允许
- 管理员
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| visitor_id | 整数 | 路径 | 真正的 | 访客的ID |
使用旋度
旋度https://www.zopim.com/api/v2/visitors/(visitor_id) \-v -u {email_address}:{password}
示例响应(年代)
200好了
状态200 OK{“禁”:假的,“创建”:“2014 - 09 - 01 t10:29:59z”,“电子邮件”:“(电子邮件保护)"，:“external_id john_extid”,“id”:1、“name”:“访客1”，注释:“这个来访者真酷。”“电话”:“+65 12345678”}
更新的游客
把/ api / v2 /访客/ {visitor_id}
允许帐户所有者/管理员更新访问者的详细信息。
允许
- 管理员
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| visitor_id | 整数 | 路径 | 真正的 | 访客的ID |
使用旋度
旋度https://www.zopim.com/api/v2/visitors/{visitor_id} \-d '{"name": "John"}' \-v -u {email_address}:{password} \-X PUT -H "Content-Type: application/json"
示例响应(年代)
200好了
状态200 OK{“禁”:假的,“创建”:“2014 - 09 - 01 t10:29:59z”,“电子邮件”:“(电子邮件保护)"，:“external_id john_extid”,“id”:1、“名称”:“约翰”,注释:“这个来访者真酷。”“电话”:“+65 12345678”}