文档 API参考

禁止

您可以使用API来获取、设置或删除禁令。

JSON格式

禁令被表示为具有以下属性的JSON对象:

的名字 类型 只读 强制性的 描述
created_at 字符串 真正的 假 创建禁令的时间戳。对于旧的禁令，这可以为空。
id 整数 真正的 假 禁令的ID
ip_address 字符串 真正的 假 禁止访问的IP地址
原因 字符串 真正的 假 禁令的原因
类型 字符串 真正的 假 禁令的类型
visitor_id 字符串 真正的 假 被禁访客的ID
visitor_name 字符串 真正的 假 被禁止的访问者的显示名称

例子

             

              
｛“created_at”：“2020 - 03 - 14 - t15:09:26z”，“id”：1，“ip_address”：“87.230.12.41”，“原因”：“垃圾邮件制造者”，“类型”：“我”，“visitor_id”：＂＂，“visitor_name”：＂＂｝

禁止列表

  • GET / api / v2 /禁令

列出该帐户的禁止。每页最多返回1000个结果。这个端点使用基于游标的分页。看到分页在列表代理。

允许

  • 管理员

参数

的名字 类型 在 要求 描述
限制 整数 查询 假 端点将返回的记录数。默认为10。
max_id 整数 查询 假 使用max_id参数对记录集进行向后分页
since_id 整数 查询 假 使用since_id参数对记录集进行向前分页

使用旋度

             

              
卷曲“https://www.zopim.com/api/v2/bans?since_id=5&limit=2”\-v -u {email_address}:{password}

示例响应(年代)

200好了 
              

               
状态200 OK｛“ip_address”:(｛“created_at”:“2020 - 03 - 14 t15:09:26z”,“id”: 8:“ip_address 242.211.134.60”,“原因”:“垃圾邮件制造者”｝),“游客”:(｛“created_at”:“2020 - 03 - 14 t15:09:26z”,“id”:5“原因”:“垃圾邮件制造者”,“visitor_id”:“2”,“visitor_name”:“约翰”｝］｝

禁用IP地址列表

  • GET / api / v2 /禁止/ ip

为您的帐户返回禁止访问的IP地址列表。

允许

  • 管理员

使用旋度

             

              
卷曲https://www.zopim.com/api/v2/bans/ip \-v -u {email_address}:{password}

示例响应(年代)

200好了 
              

               
状态200 OK［“155.69.127.97”,“155.69.127.98”］

展示禁令

  • GET / api / v2 /禁止/ {ban_id}

根据禁令的ID获取禁令。

允许

  • 管理员

参数

的名字 类型 在 要求 描述
ban_id 整数 路径 真正的 禁令的ID

使用旋度

             

              
卷曲https://www.zopim.com/api/v2/bans/(ban_id) \-v -u {email_address}:{password}

示例响应(年代)

200好了 
              

               
状态200 OK｛“created_at”:“2020 - 03 - 14 t15:09:26z”,“id”:1、:“ip_address 87.230.12.41”,“原因”:“垃圾邮件制造者”,“类型”:“我”,“visitor_id”:“”,“visitor_name”:“｝

创建禁令

  • POST / api / v2 /禁令

根据访问者ID或IP地址创建禁令。

允许

  • 管理员

使用旋度

             

              
#禁止访客卷曲https://www.zopim.com/api/v2/bans \- d”{“visitor_id”:“12345”,“原因”:“垃圾邮件制造者”} ' \-v -u {email_address}:{password} \-X POST -H "Content-Type: application/json"#或者，禁止IP卷曲https://www.zopim.com/api/v2/bans \- d”{:“ip_address 192.123.123.5”,“原因”:“垃圾邮件制造者”} ' \-v -u {email_address}:{password} \-X POST -H "Content-Type: application/json"

示例响应(年代)

201年创建 
              

               
状态201已创建｛“created_at”:“2020 - 03 - 14 t15:09:26z”,“id”:1、“ip_address”:“”,“原因”:“垃圾邮件制造者”,“类型”:“V”,“visitor_id”:“12345”,"visitor_name": "Agent Smith"｝

删除禁令

  • 删除/ api / v2 /禁止/ {ban_id}

删除禁令。

允许

  • 管理员

参数

的名字 类型 在 要求 描述
ban_id 整数 路径 真正的 禁令的ID

使用旋度

             

              
卷曲https://www.zopim.com/api/v2/bans/{ban_id} \-v -u {email_address}:{password} -X DELETE

示例响应(年代)

204无内容 
              

               
204无内容