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

客服接口


JSON格式

名称 类型 只读 必填 注释
sId int 客服ID,系统自动生成
url varchar 该客服的资源url
sPassportName 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": "张三",
    ...
  }
}

页面工具