帮我吧文档:数据接口:客服:客服

客服接口


JSON格式

名称 类型 只读 必填 注释
sId int 客服ID,系统自动生成
url varchar 该客服的资源url
sPassportName varchar 客服账号,一旦创建就无法修改
password varchar 客服密码 ,不传值则默认为管理员在帮我吧后台设置密码
groupId varchar 客服所属分组ID,系统自动生成,一个客服可属于多个分组,此时以逗号分隔,具体格式见JSON示例
sNum varchar 客服工号
name varchar 客服姓名
gnder tinyint 客服性别:1-女,2-男,默认是1
email varchar 电子邮箱
fixnumber varchar 座机号码
mobile varchar 手机号码
QQ varchar QQ号码
isAdmin tinyint 是否是管理员:0-非管理员,1-管理员,默认为0
createDT datetime 创建时间,格式为:2018-02-03 00:00:00

JSON示例

{
     "sId": 1,
     "url": "https://www.bangwo8.com/api/v1/supports/1.json",
     "sPassportName": "张三",
     "groupId": "123,234",
     "sNum": "888",
     "name": "张三",
     "gnder": "2",
     "email": "601100987@gnway.com",
     "fixnumber": "010-63701717-8280",
     "mobile": "13240139489",
     "QQ": "601100987",
     "isAdmin": "0",
     "createDT": "2017-09-12 10:12:22"
}

获取客服列表

GET /api/v1/supports.json

查询参数

名称 必需的 类型 注释
created_start string 按创建时间筛选,开始时间
created_end string 按创建时间筛选,结束时间
created_order string 按创建时间排序,取值为:asc-升序,desc-降序
page int 分页获取,默认为1
per_page int 每页大小,默认为100

说明:默认按编码升序返回。时间参数(created_start、created_end)格式为“2012-01-01 00:00:00”。

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/supports.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
	"supports": [
		{
			"sId": 1,
			"name": "张三",
			...
		},
		{
			"sId": 2,
			"name": "李四",
			...
		}
	],
        "count": 42,
        "next_page": "https://www.bangwo8.com/api/v1/supports.json?per_page=40&page=2",
        "previous_page": null
}

查看指定客服信息

GET /api/v1/supports/{id}.json

调用者权限

所有客服

调用示例

curl https://www.bangwo8.com/api/v1/supports/{id}.json \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "support": {
    "sId":   1,
    "name": "张三",
    ...
  }
}

获取多个客服信息

GET /api/v1/supports/show_many.json?ids={ids}

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/supports/show_many.json?ids=1,2,3 \
  -v -u {account}:{password}

返回值示例

Status: 200 OK

{
  "supports": [
    {
      "sId": 1,
      "name": "张三",
      ...
    },
    {
      "sId": 2,
      "name": "李四",
      ...
    }
  ]
}

创建客服

POST /api/v1/supports.json

调用者权限

管理员

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/supports.json \
  -H "Content-Type: application/json" -X POST -d '{"support": {"sPassportName": "gnwayservice", \
  "sNum": "8801", "name": "张三"}}'

说明:
1、创建客服时,sPassportName和sNum必填。
2、当一个客服属于多个分组时,多个分组以逗号分隔,具体格式如下:{“groupId”: “123,234”}。

返回值示例

Status: 200 OK
Location: https://www.bangwo8.com/api/v1/supports/{id}.json

{
  "support": {
    "sId":   11,
    "name": "张三",
    ...
  }
}

修改客服信息

PUT /api/v1/supports/{id}.json

调用者权限

所有客服

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/supports/123.json \
  -H "Content-Type: application/json" -X PUT -d '{"support": {"name": "张三"}}'

返回值示例

Status: 200 OK

{
  "support": {
    "sId":   11,
    "name": "张三",
    ...
  }
}

删除客服信息

DELETE /api/v1/supports/{id}.json

调用者权限

管理员

调用示例

curl -v -u {account}:{password} https://www.bangwo8.com/api/v1/supports/932845.json \
  -H "Content-Type: application/json"
  -X DELETE

返回值示例

Status: 200 OK
{
    "support": {
        "sId": "932845",
        "sPassportName": "gnly003",
        "groupId": "264586,266059",
        "sNum": "003",
        "name": "卢园",
        "gnder": "1",
        "email": "",
        "fixnumber": "",
        "mobile": "15506843512",
        "QQ": "",
        "isAdmin": "0",
        "createDT": "2020-06-02 11:42:20"
    }
}

搜索客服信息

GET /api/v1/supportgroups/supports/search.json

查询参数

名称 必需的 类型 注释
query string 搜索内容(模糊搜索)
sort_bystring 按时间排序,目前支持:createDT-创建时间,updateDT-更新时间
sort_orderstring 按升序还是降序返回,取值为:asc-升序,desc-降序,默认为降序序

说明:默认按编码升序返回。时间参数(created_start、created_end)格式为“2012-01-01 00:00:00”。

query参数说明

搜索内容 返回结果
query=sPassportName:ademi 搜索客服账号为ademi的客服信息
query=name:陆华搜索客服姓名为陆华的客服信息
query=sNum:001搜索客服工号为001的客服信息
query=mobile:15586943723搜索客服手机号码为15586943723的客服信息(通过手机号账号查询客服的时候,每10条会分页显示)

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/supportgroups/supports/search.json?query=sPassportName:ademi
  -H "Content-Type: application/json" \
   -v -u {account}:{password} -X GET

返回值示例

Status: 200 OK
{
   "supports": [
            {
            "sId": "563562",
            "sPassportName": "ademi",
            "groupId": "",
            "sNum": "005",
            "name": "刘经理",
            "gnder": "2",
            "email": "",
            "fixnumber": "",
            "mobile": "13076869445",
            "QQ": "",
            "isAdmin": "0",
            "createDT": "2019-08-15 16:29:05"
        }
    ],
    "count": "1",
    "previous_page": "",
    "next_page": ""
}

页面工具