开发者文档 开发者文档
帮助中心 (opens new window)
帮助中心 (opens new window)
  • API调用说明
  • CRM 产品 API
  • 客服管理 API
    • iFrame 对接
    • 单点登录
    • 商城中心
    • 公共模块 API
    智齿科技
    2022-05-19
    目录

    客服管理 API

    # 客服管理 API

    # 接口声明

    在调用接口时必须在 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 来传达,目前是 86,400 秒之内的值。开发者需要根据这个有效时间提前去刷新新 Token。
    3、开发者需要根据接口返回的 Token 失效提示,进行重新获取 Token。

    # 接口调用

    # ● 获取访问 Token 编码

    接口说明:

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

    请求方式:

    GET

    请求地址:

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

    请求参数:

    参数 类型 必填 描述
    appid String 是 第三方用户接口调用唯一凭证id
    create_time String 是 时间戳(秒),例如:2019-09-25 15:49:33 的时间戳1569397773
    sign String 是 签名,md5(appid+create_time+app_key) sign签名,app_key为密钥

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    item Object 否 返回对象

    item对象:

    参数 类型 必填 描述
    token String 是 token编码
    expires_in String 是 凭证有效时间,单位:秒

    时间戳转换参考工具:

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

    sign签名生成示例:

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

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

    返回示例:

    {
       "item": {
           "token": "4ac37cb2e9c740dba4b75a34d5358802",
           "expires_in": "86400"
       },
       "ret_code": "000000",
       "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    # ● 查询坐席角色

    接口说明:

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

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/agent/query_agent_roles
    
    1

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 否 对象列表

    items集合:

    参数 类型 必填 描述
    dict_value String 否 角色ID
    dict_name String 否 角色名称
    dict_remark String 否 备注

    返回示例:

    {
        "items": [
            {
                "dict_name": "测试编码",
                "dict_remark": "测试编码",
                "dict_value": "1409795602669862969"
            },
            {
                "dict_name": "测试编码2",
                "dict_remark": "556666",
                "dict_value": "1409796429186605113"
            }
        ],
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    # ● 查询组织结构

    接口说明:

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

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/agent/query_departments
    
    1

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 是 对象列表

    items集合:

    参数 类型 必填 描述
    companyid String 是 公司ID
    departid String 是 部门ID
    depart_name String 是 部门名称
    depart_level String 是 部门级别
    depart_type String 是 部门职能,1-在线,2-呼叫,3-电销,4-工单(部门职能可能有多个,多个以逗号分隔,例如:1,2,3)
    parentid String 是 所属父级部门ID
    sub_department_list List 否 子级部门信息

    sub_department_list集合:

    参数 类型 必填 描述
    companyid String 是 公司ID
    departid String 是 部门ID
    depart_name String 是 部门名称
    depart_level String 是 部门级别
    depart_type String 是 部门职能,1-在线,2-呼叫,3-电销,4-工单(部门职能可能有多个,多个以逗号分隔,例如:1,2,3)
    parentid String 是 所属父级部门ID

    返回示例:

    {
        "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": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    # ● 查询技能组

    接口说明:

    获取所属公司技能组信息

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/agent/query_groups
    
    1

    请求参数:

    参数 类型 必填 描述
    page_no Integer 是 起始页码,不传或参数为错误值,默认1
    page_size Integer 是 每页条数,不传或参数为错误值,默认每页15条

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 是 对象列表
    page_count Integer 是 共几页
    page_no Integer 是 起始页
    page_size Integer 是 每页条数
    total_count Integer 是 数据条数

    items集合:

    参数 类型 必填 描述
    groupid String 是 技能组ID
    group_name String 是 技能组名称
    group_type String 是 技能组类型,0工单坐席组,1在线坐席组,2电话坐席组,3 电销组

    返回示例:

    {
        "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": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    # ● 新增技能组

    接口说明:

    新增所属公司技能组信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/group/save_groups
    
    1

    请求参数:

    参数 类型 必填 描述
    group_name String 是 技能组名称
    group_type String 是 技能组类型,0工单客服组,1在线客服组

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    item Object 是 返回数据

    items集合:

    参数 类型 必填 描述
    groupid String 是 技能组ID
    group_name String 是 技能组名称
    group_type String 是 技能组类型,0工单客服组,1在线客服组,2电话客服组,3 电销组

    返回示例:

    {
        "item": [{
             "groupid": "3bfe772e943c461b9cf6f47440c1a72a",
             "group_name": "客户组",
             "group_type": "0"
        }],
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    # ● 更新技能组

    接口说明:

    更新所属公司技能组信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/group/update_groups
    
    1

    请求参数:

    参数 类型 必填 描述
    group_name String 是 技能组名称
    groupid String 是 技能组ID

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 删除技能组

    接口说明:

    删除所属公司技能组信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/group/delete_groups
    
    1

    请求参数:

    参数 类型 必填 描述
    groupid String 是 技能组id

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 增加坐席到技能组

    接口说明:

    增加坐席到技能组

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/group_agent/save_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    agent_ids String 是 坐席ID,多个坐席ID用英文逗号","隔开
    groupid String 是 技能组ID

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 删除技能组内坐席

    接口说明:

    删除技能组内坐席

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/group_agent/delete_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    groupid String 是 技能组ID
    agentid String 是 坐席ID

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 查询技能组内坐席

    接口说明:

    查询技能组内坐席

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/group_agent/query_agents
    
    1

    请求参数:

    参数 类型 必填 描述
    groupid String 是 技能组id

    请求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/public/5/group_agent/query_agents?groupid=7cb2e9c740dba4b75a34d53588
    
    1

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 是 对象列表

    items集合:

    参数 类型 必填 描述
    companyid String 是 企业ID
    create_agentid String 是 创建人ID
    create_time Long 是 创建时间
    agent_role_type String 是 角色类型,参见角色类型字典表
    agent_role_name String 是 角色名称,参见角色类型字典表
    effect_time Long 否 生效时间
    login_status String 否 登陆状态, 0未登录,1登录
    phone_no String 否 手机号码
    agent_email String 是 坐席邮箱
    agentid String 是 坐席ID
    agent_name String 是 坐席名称
    agent_nick String 是 坐席昵称
    agent_status String 是 坐席状态,0未激活,1启用中,2平台管控,9停用,-1删除
    update_time String 是 更新时间

    返回示例:

    {
        "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": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    # ● 查询坐席列表

    接口说明:

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

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/agent/query_agents
    
    1

    请求参数:

    参数 类型 必填 描述
    page_no Integer 是 起始页,不传或参数为错误值,默认1
    page_size Integer 是 每页显示条数,不传或参数为错误值,默认每页15条

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 是 对象列表
    page_count Integer 是 共几页
    page_no Integer 是 起始页
    page_size Integer 是 每页条数
    total_count Integer 是 数据条数

    items集合:

    参数 类型 必填 描述
    agentid String 是 坐席ID
    companyid String 是 公司ID
    agent_name String 是 坐席真实名称
    agent_nick String 是 坐席昵称
    agent_status String 是 坐席状态,1启用中,9停用,-1删除
    agent_email String 是 坐席邮箱
    phone_no String 否 坐席手机号
    max_accept Integer 否 坐席最大接待上限
    agent_role_type String 是 坐席角色类型,1超级管理员,2管理员,3普通客服
    agent_roleid String 是 坐席角色ID
    agent_role_name String 是 坐席角色名称
    departid String 否 坐席所属部门ID
    depart_name String 否 坐席所属多部门,部门名称之间以逗号分隔
    agent_no String 否 坐席工号
    main_departid String 否 客服主部门id
    main_depart_name String 否 客服主部门名称
    workbench_lang String 是 客服工作台语言
    agent_partner_id String 否 对接id
    duty String 否 职务

    返回示例:

    {
        "items": [
            {
                "companyid": "5ae23431d5604fe3ada6b5a76fa11b40",
                "agent_role_type": "1",
                "agent_roleid": "147239050240283",
                "agent_role_name": "超级管理员",
                "departid": "6cb6f51864761bf63ebf753bdf1e9",
                "depart_name": "总公司",
                "phone_no": "17611470819",
                "max_accept": 10,
                "agent_email": "zhang@sobot.com",
                "agentid": "557116dd94b9585e0a163b7160401",
                "agent_name": "张",
                "agent_nick": "张",
                "agent_status": "1",
                "agent_no": "1"
            }
        ],
        "page_count": 1,
        "page_no": 1,
        "page_size": 15,
        "ret_code": "000000",
        "ret_msg": "操作成功",
        "total_count": 1
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    # ● 新增坐席信息

    接口说明:

    新增坐席信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/agent/save_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    agent_nick String 是 坐席昵称
    agent_name String 是 坐席真实名称
    phone_no String 否 手机号码
    password String 否 密码
    email String 是 坐席邮箱
    agent_roleid String 是 坐席角色ID
    departid String 是 部门ID,多个部门ID请用“,”隔开
    max_accept String 是 最大接待上限,0-100的正整数
    agent_no String 否 坐席工号
    main_departid String 否 客服主部门id,该参数为空时,会以departid中的第一个值作为主部门
    workbench_lang String 否 客服工作台语言
    agent_partner_id String 否 对接id

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    item Object 是 返回对象

    item对象:

    参数 类型 必填 描述
    companyid String 是 公司ID
    agent_nick String 是 坐席昵称
    agent_name String 是 坐席真实名称
    agentid String 是 坐席ID

    返回示例:

    {
        "item": {
            "companyid":"6573198191ad4b17a0173c9bb1b012fe",
            "agent_nick":"客户09104",
            "agent_name":"张",
            "agentid":"557116dd94b9585e0a163b7160401"
        },
        "ret_code": "00000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    # ● 更新坐席信息

    接口说明:

    更新坐席信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/agent/update_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    agentid String 是 坐席ID
    agent_nick String 是 坐席昵称
    agent_name String 是 坐席真实姓名
    agent_roleid String 是 坐席角色ID
    departid String 是 部门ID,多个部门ID请用“,”隔开
    max_accept String 是 最大接待上限, 0-100正整数
    phone_no String 否 坐席手机号
    agent_status String 否 坐席状态,1启用中,9停用,-1删除 (坐席状态是已启用可以修改为停用,反之停用可以修改为启用,其余状态不可修改)
    agent_no String 否 坐席工号
    main_departid String 否 客服主部门id,该参数为空时,会以departid中的第一个值作为主部门
    workbench_lang String 否 客服工作台语言
    agent_partner_id String 否 对接id

    请求示例:

    curl https://www.sobot.com//api/public/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":"147239050240283","email":"zhang@sobot.com","departid":"0256cb6f513bdf1e9","max_accept":10}'
    
    1
    2

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    item Object 是 返回对象

    item对象:

    参数 类型 必填 描述
    companyid String 是 公司ID
    agent_nick String 是 坐席昵称
    agent_name String 是 坐席真实名称

    返回示例:

    {
        "item": {
            "companyid":"6573198191ad4b17a0173c9bb1b012fe",
            "agent_nick":"客4",
            "agent_name":"刘"
        },
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    # ● 删除坐席信息

    接口说明:

    删除坐席信息

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/agent/delete_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    agentid String 是 坐席ID

    请求示例:

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

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 批量创建坐席

    接口说明:

    批量创建坐席

    请求方式:

    POST

    请求地址:

    https://www.sobot.com/api/public/5/agent/batch_save_agent
    
    1

    请求参数:

    参数 类型 必填 描述
    agent_nick String 是 坐席昵称
    agent_name String 是 坐席真实名称
    phone_no String 否 手机号码
    password String 否 密码
    email String 是 坐席邮箱
    agent_roleid String 是 坐席角色ID
    departid String 是 部门ID,多个部门ID请用“,”隔开
    max_accept String 是 最大接待上限, 0-100的正整数
    agent_no String 否 坐席工号
    main_departid String 否 客服主部门id,该参数为空时,会以departid中的第一个值作为主部门
    workbench_lang String 否 客服工作台语言
    agent_partner_id String 否 对接id

    请求示例:

    curl https://www.sobot.com//api/public/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_roleid":"147239050240283","max_accept":"23","departid":"123","password":"1234"},
    {"email":"1234er@sobot.com","agent_name":"测试1","agent_nick":"昵称1","agent_roleid":"147239050240283","max_accept":"23","departid":"123","password":"1234"}
    ]'
    
    1
    2
    3
    4
    5

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息

    返回示例:

    {
        "ret_code": "000000",
        "ret_msg": "操作成功"
    }
    
    1
    2
    3
    4
    # ● 查询坐席信息

    接口说明:

    查询坐席信息

    请求方式:

    GET

    请求地址:

    https://www.sobot.com/api/public/5/agent/list
    
    1

    请求参数:

    参数 类型 必填 描述
    agentid String 否 坐席id
    agent_name String 否 坐席真实名称
    email String 否 坐席邮箱
    departid String 否 部门id
    page_no Integer 否 起始页,不传或参数为错误值,默认1
    page_size Integer 否 每页显示条数,不传或参数为错误值,默认每页15条

    请求示例:

    curl -H 'token:4ac37cb2e9c740dba4b75a34d5358802' https://www.sobot.com/api/public/5/agent/list?agentid=f70ade8aac31457bb182417b0cfe447c
    
    1

    返回参数:

    参数 类型 必填 描述
    ret_code String 是 返回编码
    ret_msg String 是 返回信息
    items List 是 对象列表
    page_count Integer 是 共几页
    page_no Integer 是 起始页
    page_size Integer 是 每页条数
    total_count Integer 是 数据条数

    items集合:

    参数 类型 必填 描述
    companyid String 是 企业ID
    agent_roleid String 是 坐席角色ID
    agent_role_type String 是 角色类型,参见角色类型字典表
    agent_role_name String 是 角色名称,参见角色类型字典表
    phone_no String 否 手机号码
    agent_email String 是 坐席邮箱
    agentid String 是 坐席ID
    agent_name String 是 坐席名称
    agent_nick String 是 坐席昵称
    agent_status String 是 坐席状态,0未激活,1启用中,2平台管控,9停用,-1删除
    departid String 是 部门ID,多个部门ID请用“,”隔开
    depart_name String 否 坐席所属多部门,部门名称之间以逗号分隔
    max_accept String 是 最大接待上限, 0-100的正整数
    agent_no String 否 坐席工号
    workbench_lang String 是 客服工作台语言
    agent_partner_id String 否 对接id
    duty String 否 职务

    返回示例:

    {
      "items": [
        {
          "agent_email": "ed78cb778e6adc5cc7bbb6e03e41a0ec@corp26022.sobot.com",
          "agent_name": "真实姓名_real",
          "agent_nick": "昵称",
          "agent_no": "007",
          "agent_role_name": "微智管理员",
          "agent_role_type": "2",
          "agent_roleid": "1422878660180328449",
          "agent_status": "1",
          "agentid": "f70ade8aac31457bb182417b0cfe447c",
          "companyid": "60b7e31daf15417aa0f521aa7d822ddd",
          "depart_name": "智齿众服,BBBB-研发部门",
          "departid": "78f26da140dbba9b637144bd858fcd26,91bbff23c25dbb2aa98f9c4df1f7c0f9",
          "max_accept": 8,
          "phone_no": "15650752293"
        }
      ],
      "page_count": 1,
      "page_no": 1,
      "page_size": 15,
      "ret_code": "000000",
      "ret_msg": "操作成功",
      "total_count": 1
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26

    # 接口返回状态编码

    # ● 操作成功
    返回编码 编码说明
    000000 操作成功(除此编码以外的编码为错误编码)
    # ● 系统异常
    返回编码 编码说明
    700046 当前企业所购的版本不支持使用接口(免费版、海外团队版不可使用)
    900001 token为空
    900002 token已失效,请重新获取
    900003 signature错误
    900004 没有找到公司的api配置信息
    999999 系统未知异常
    # ● 业务异常
    返回编码 编码说明
    700001 公司ID不允许为空
    700002 坐席ID不允许为空
    700003 坐席昵称不允许为空
    700004 坐席真实姓名不允许为空
    700005 坐席角色ID不允许为空
    700006 坐席角色id不存在
    700007 坐席邮箱不允许为空
    700008 坐席邮箱格式不正确
    700009 坐席邮箱已存在
    700010 邮箱未注册
    700011 坐席昵称输入过长
    700012 坐席名称输入过长
    700013 坐席昵称不能包含标签符号
    700014 接待上限数字格式错误!只能输入0~100的整数数字
    700015 坐席部门与角色不匹配,请重新选择
    700016 请求参数错误
    700017 当前坐席无法被更改
    700018 坐席角色与所选的部门职能不匹配,请重新选择坐席角色或所属部门
    700019 手机号码格式不正确
    700020 手机号码为空
    700021 名额已达到上限!如需增加,请联系智齿售后进行购买
    700022 无法完成部门内管理员和普通坐席角色的转换,请先前往【组织架构】页移除该坐席,再回来更改角色!
    700024 技能组名称过长
    700025 技能组名称已重复,请重新输入
    700026 技能组名称不能为空
    700027 技能组id不能为空
    700028 当前坐席处于登录状态,无法从技能组中移除,待其下线后再操作!
    700029 请先删除对应的触发器或SLA
    700030 技能组还在智能路由里面,暂时不能删除,请您先移除智能路由里面分配的该技能组再重新删除!
    700031 记录不存在!
    700032 操作失败,该组员已登录,请待其退出系统后再操作。
    700033 该坐席没有开通呼叫中心,暂时不能添加!
    700034 呼入客服组和电销组总共不能超过100个
    700035 添加失败,坐席id[id值]不存在,超过可添加坐席范围
    700036 添加失败,坐席id[id值]在电销技能组已存在
    700037 技能组id不存在
    700038 该坐席角色为超级管理员,不允许修改
    700039 该坐席角色为超级管理员,不允许删除
    700040 不允许将角色修改为超级管理员,请登陆系统后操作
    700041 坐席邮箱输入过长
    700042 坐席状态不正确
    700043 坐席角色不正确
    700044 坐席部门ID不允许为空
    700045 坐席部门ID不正确
    700666 对接id重复
    700667 对接id长度超过100字符
    上次更新: 2025/2/7 16:15:31

    ← CRM 产品 API iFrame 对接→

    最近更新
    01
    运营支持 API
    03-03
    02
    CRM 对接方案
    12-05
    03
    大模型机器人API
    09-09
    更多文章>
    Theme by Vdoing
    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式