1.1 接口说明

在优音云客服系统创建工单模板后,第三方系统可以通过该接口在系统中完成工单创建。

1.2 调用形式

https://ykf.uincall.com/openapi/workorder/new?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

1.3 调用方式

POST

1.4 传入参数

非必填参数,调用接口时请传递参数名,参数值可为空

序号 名称 类型 是否必填 说明
1 workflow_id String 工作流模板ID
2 agent_num String 管理员工号,如1234
3 customer_id String 客户ID。1、从4.4章节接口回应参数data结果集中可获取;2、如不传时,则默认在租户客户管理中创建名为“未命名客户”的新客户

1.5 回应参数

说明:
该章节中回应参数 data 元素4.2章节第一个节点流入(流转)工单的报文封装;

序号 名称 类型 是否必填 说明
1 errcode Number 状态码:0成功,及其他非0错误码,详见错误码列表
2 errmsg String 状态说明
3 data Object类型数组 结果集
3.1 form Object类型对象 新建工单的表单元素
3.1.1 rows Object类型数组 form下元素数组rows包含表单多个元素:元素对象属性1、title:字段名称;
2、kind:字段类型,点击查看详情
0-自定义单行文本;
1-自定义多行文本;
2-自定义单选;
3-自定义多选;
4-自定义下拉框;
5-自定义日期;
6-自定义日期时间;
7-自定义数字;
8-附件;
3、id:元素ID;
4、val:字符型字段值;(若为附件类型元素则是Object类型数组)点击查看详情
Object类型属性如下:
4.1name:名称;
4.2uid:数据标识(Long型时间戳值,若为多个附件元素元素对象时,必须保证唯一);
4.3url: 地址;
3.2 priority Number 流转工单的优先级(0-紧急 1-重要 2-普通)
3.3 workflow_id String 工作流模板ID
3.4 process_instance_id String 流程实例id
3.5 task_id String 工作流任务ID(为流转工单的任务节点ID)
3.6 target_agent_num Number 为下步处理座席工号
3.7 agent_num Number 为当前管理员工号,如1234

1.6 使用样例

调用:

url:https://ykf.uincall.com/openapi/workorder/new?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

POST数据:
{
    "customer_id": "9ff7cd3d9c70b6e8fb7f1a824cdxxxxx",
    "workflow_id": "8c1f9395d43b1449e6e47fd44e1xxxxx",
    "agent_num": "1005"
}

响应:

{
"errcode": 0,
"errmsg": "success",
"data": {
    "form": {
        "rows": [
            {
                "val": "",
                "kind": 0,
                "id": "3741f7a0-0465-4f36-9b7f-f3bd875xxxxx",
                "title": "合同名称"
            },
            {
                "val": "",
                "kind": 0,
                "id": "0c01dded-664a-4a5b-9b22-d108b8cxxxxx",
                "title": "合同编号"
            },
            {
                "val": "",
                "kind": 4,
                "id": "e9e53277-4864-4d95-9865-79707fexxxxx",
                "title": "是否邮寄"
            },
            {
                "val": "1",
                "kind": 2,
                "id": "7c84a23f-39f8-47d6-a596-629f211xxxxx",
                "title": "性别"
            },
            {
                "val": "",
                "kind": 4,
                "id": "e9e53277-4864-4d95-9865-79707fexxxxx",
                "title": "是否邮寄"
            },
            {
                "val": "",
                "kind": 5,
                "id": "6ce4a733-b722-4c23-add3-89c41b1xxxxx",
                "title": "执行日期"
            },
            {
                "val": "",
                "kind": 6,
                "id": "ea06e5cd-e9f1-4c9f-b37d-e27447exxxxx",
                "title": "执行具体时间"
            },
            {
                "val": "",
                "kind": 7,
                "id": "94ef5b5e-8638-4fb8-be4d-1db00adxxxxx",
                "title": "金额"
            },
            {
                "val": "",
                "kind": 1,
                "id": "8a4530a5-eb68-47a0-a358-f2dea15xxxxx",
                "title": "备注"
            },
            {
                "val": [
                    {
                        "uid": 16287670xxxxx,
                        "name": "",
                        "url": ""
                    }
                ],
                "kind": 8,
                "id": "c3d68aeb-d2cb-4e5c-8ad6-cc25555xxxxx",
                "title": "附件"
            },
            {
                "val": "云坐席",
                "kind": 3,
                "id": "5a3cc8c3-f98a-4ba7-a097-109ed18xxxxx",
                "title": "企业套餐"
            }
        ]
    },
    "priority": 2,
    "workflow_id": "8c1f9395d43b1449e6e47fd4xxxxxxxx",
    "task_id": "6bc00b7a-0034-11ec-8e2a-0050xxxxxxxx",
    "target_agent_num": "",
    "agent_num": "8888"
    }
}
文档更新时间: 2024-03-25 15:18   作者:admin