客服管理

1、接口声明

在调用接口时必须在https请求的header中携带"token"参数。

token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token，开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时，需定时刷新，或根据接口返回的token失效提示，进行重新获取。请求token接口，无论token是否存在，都会返回新的token，并重置token的过期时间(目前24小时)。

token使用方式说明：
1、开发者需要统一获取和管理token，在调用智齿客服各个业务开放接 口时都应该使用同一个的token，不应该每个业务都刷新获取新的 token，否则容易导致token失效，影响接口的正常调用；
2、目前token的有效期通过返回的expire_in来传达，目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示，进行重新获取token。

2、接口调用

2.1、获取访问token编码

接口说明：

获取API开放接口token，此token仅适用于智齿开放平台 5.0版本全部API接口 。API接口中的参数 appid, app_key 请联系智齿售后人员获取。

请求方式：

GET

请求地址：

https://www.sobot.com/api/get_token

请求参数：

返回参数：

item对象：

时间戳转换参考工具：

http://tool.chinaz.com/Tools/unixtime.aspx

sign签名生成示例：

例如，appid = "1"; create_time="1569397773"; app_key="2"

sign = Md5("115693977732") 为 258eec3118705112b2c53dc8043d4d34。

请求示例：

curl https://www.sobot.com/api/get_token?appid=1&create_time=1569397773&sign=258eec3118705112b2c53dc8043d4d34

返回示例：

{
    "item": {
        "token": "4ac37cb2e9c740dba4b75a34d5358802",
        "expires_in": "86400"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.2、查询坐席角色

接口说明：

获取系统中添加坐席所需的角色信息。

请求方式：

GET

请求地址：

/api/basic/5/agent/query_agent_roles

返回参数：

items对象

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/basic/5/agent/query_agent_roles

返回示例：

{
    "items": [
        {
            "dict_name": "全功能管理员",
            "dict_remark": "坐席信息表：坐席角色",
            "dict_value": "4444"
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.3、查询组织结构

接口说明：

获取系统中添加坐席所需的组织结构信息

请求方式：

GET

请求地址:

/api/basic/5/agent/query_departments

返回参数：

items对象

sub_department_list对象

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/basic/5/agent/query_departments

返回示例：

{
    "items": [
        {
            "companyid": "5ae2343ada6b5a76fa11b40",
            "departid": "0256cb6f51864761bf63ebf753bdf1e9",
            "depart_level": "0",
            "depart_name": "总公司",
            "depart_type": "1,2,3,4",
            "parentid": "0",
            "subdepartment_list": [
                {
                    "companyid": "5ae23431d5604fe3ada6b5a76fa11b40",
                    "departid": "c07d93d438be438ca3ba19e88b2d608f",
                    "depart_level": "1",
                    "depart_name": "二号部门",
                    "depart_type": "4",
                    "parentid": "0256cb6f51864761bf63ebf753bdf1e9",
                }
            ],
        }
    ],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.4、查询技能组

接口说明：

获取所属公司技能组信息

请求方式：

GET

请求地址:

/api/basic/5/agent/query_groups

请求参数：

返回参数：

items对象

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/basic/5/agent/query_groups?page_no=1&page_size=15

返回示例：

{
    "items": [{
        "groupid": "3bfe772e943c461b9cf6f47440c1a72a",
        "group_name": "A",
        "group_type": "1"
    }],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "totalcount": 1,
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.5、新增技能组

接口说明：

新增所属公司技能组信息

请求方式：

POST

请求地址:

/api/basic/5/group/save_groups

请求参数：

返回参数：

items对象

请求示例：

curl https://www.sobot.com/api/basic/5/group/save_groups -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{"group_name":"客户组","group_type":"0"}'

返回示例：

{
    "item": [{
         "groupid": "3bfe772e943c461b9cf6f47440c1a72a",
         "group_name": "客户组",
         "group_type": "0"
    }],
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.6、更新技能组

接口说明：

更新所属公司技能组信息

请求方式：

POST

请求地址:

/api/basic/5/group/update_groups

请求参数：

返回参数：

请求示例：

curl https://www.sobot.com/api/basic/5/agent/update_groups -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{"group_name":"客户组","groupid":"37cb2e9c740dba4b75a34d535880"}'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.7、删除技能组

接口说明：

删除所属公司技能组信息

请求方式：

POST

请求地址:

/api/basic/5/group/delete_groups

请求参数：

返回参数：

请求示例：

curl https://www.sobot.com/api/basic/5/group/delete_groups -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{"groupid":"7cb2e9c740dba4b75a34d53588"}'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.8、增加坐席到技能组

接口说明：

增加坐席到技能组

请求方式：

POST

请求地址:

/api/basic/5/group_agent/save_agent

请求参数：

返回参数：

请求示例：

curl https://www.sobot.com/api/basic/5/agent/save_groups_agent -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{" agent_ids":"7cb2e9c740dba4b75a34d53588,4ac37cb2e9c740dba4b75a34d5358","groupid":"7cb2e9c740dba4b75a34d53588"}'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.9、删除技能组内坐席

接口说明：

删除技能组内坐席

请求方式：

POST

请求地址:

/api/basic/5/group_agent/delete_agent

请求参数：

返回参数：

请求示例：

curl https://www.sobot.com/api/basic/5/group_agent/delete_agent -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{
"agentid":"7cb2e9c740dba4b75a34d53588","groupid":"7cb2e9c740dba4b75a34d53588"}'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.10、查询技能组内坐席

接口说明：

查询技能组内坐席

请求方式：

GET

请求地址:

/api/basic/5/group_agent/query_agents

请求参数：

返回参数：

items对象 :

请求示例：

curl https://www.sobot.com/api/basic/5/group_agent/query_agents -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{
"groupid":"7cb2e9c740dba4b75a34d53588"}'

返回示例：

{
    "items": [
        { 
        "companyid": "5ae23431d5604f6b5a76fa11b40",
        "create_agentid": "5571169a9dd94b9a163b7160401",
        "create_time": 1567499327,
        "agent_role_type": "333",
        "agent_role_name": "超级管理员",
        "effect_time": 1567499327,
        "login_status": 1,
        "phone_no": "176114332019",
        "agent_email": "zhags@sobot.com",
        "agentid": "5571169a9dd94bsfsdsa163b7160401",
        "agent_name": "张晓",
        "agent_nick": "张晓",
        "agent_status": 1,
        "update_time": 1567499327
        }
    ],
    "retCode": "000000",
    "retMsg": "操作成功"
}

2.11、查询坐席列表

接口说明：

查询所属公司所有坐席信息

请求方式：

GET

请求地址:

/api/basic/5/agent/query_agents

请求参数：

返回参数：

items对象

groups对象

请求示例：

curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/basic/5/agent/query_agents?page_no=1&page_size=15

返回示例：

{
    "items": [
        {
            "companyid": "5ae23431d5604fe3ada6b5a76fa11b40",
            "agent_role_type": "3333",
            "agent_role_name": "超级管理员",
            "departid": "6cb6f51864761bf63ebf753bdf1e9",
            "depart_name": "总公司",
            "group_name": "A",
			"groups": [
        	  {
            	"groupid": "3bfe772e943c461b9cf6f47440c1a72a",
            	"group_name": "A",
            	"group_type": "1"
        	  }
            ],
            "phone_no": "17611470819",
            "agent_email": "zhang@sobot.com",
            "agentid": "557116dd94b9585e0a163b7160401",
            "agent_name": "张",
            "agent_nick": "张",
            "agent_status": "1",
        }
    ],
    "page_count": 1,
    "page_no": 1,
    "page_size": 15,
    "ret_code": "000000",
    "ret_msg": "操作成功",
    "total_count": 1
}

2.12、新增坐席信息

接口说明：

新增坐席信息

请求方式:

POST

请求地址:

/api/basic/5/agent/save_agent

请求参数：

返回参数：

item对象

请求示例：

curl https://www.sobot.com/api/basic/5/agent/save_agent -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{"agent_nick":"客户09104","agent_name":"张","agent_role_type":"333","email":"zhang@sobot.com","departid":"0256cb6f513bdf1e9","groupids":"3bc2a","max_accept":10}'

返回示例：

{
    "item": {
        "companyid":"6573198191ad4b17a0173c9bb1b012fe",
        "agent_nick":"客户09104",
        "agent_name":"张",
        "agentid":"xxx"
    },
    "ret_code": "00000",
    "ret_msg": "操作成功"
}

2.13、更新坐席信息

接口说明：

更新坐席信息

请求方式:

POST

请求地址:

/api/basic/5/agent/update_agent

请求参数：

返回参数：

item对象

请求示例：

curl https://www.sobot.com/api/basic/5/agent/update_agent -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '{"agent_nick":"客4","agent_name":"刘",""phone_no":"17847586079","agent_roleid":"333","email":"zhang@sobot.com","departid":"0256cb6f513bdf1e9","group_ids":"3bc2a","max_accept":10}'

返回示例：

{
    "item": {
        "companyid":"6573198191ad4b17a0173c9bb1b012fe",
        "agent_nick":"客4",
        "agent_name":"刘"
    },
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.14、删除坐席信息

接口说明：

删除坐席信息

请求方式:

POST

请求地址:

/api/basic/5/agent/delete_agent

请求参数：

返回参数：

请求示例：

curl -X POST -H 'token:4ac37cb2e9c740dba4b75a34d5358802'
https://www.sobot.com/api/basic/5/agent/delete_agent 
-d '{"agentid":"e836ef1e8984fc5bc8af3"}'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

2.15、批量创建坐席

接口说明：

批量创建坐席

请求方式:

POST

请求地址:

/api/basic/5/agent/batch_save_agent

请求参数：

返回参数：

请求示例：

curl https://www.sobot.com/api/basic/5/agent/batch_save_agent -X POST -H 'content-type: application/json' -H 'token: 4ac37cb2e9c740dba4b75a34d5358802' \
-d '[
{"email":"jkljlj@sobot.com","agent_name":"测试1","agent_nick":"昵称1","agent_role_type":"1111","max_accept":"23","departid":"123","agent_no":"111","password":"1234","group_ids":"1,2,3"},
{"email":"1234er@sobot.com","agent_name":"测试1","agent_nick":"昵称1","agent_role_type":"1111","max_accept":"23","departid":"123","agent_no":"111","password":"1234","group_ids":"1,2,3"}
]'

返回示例：

{
    "ret_code": "000000",
    "ret_msg": "操作成功"
}

3、错误编码

3.1、操作成功

业务操作成功。

3.2、系统异常

系统服务异常。

3.3、业务异常

业务异常。

4、角色类型字典表