文档中心 > API类目 > 钉钉API

qimen.dingtalk.flow.form (钉钉审批开放表单)

审批表单接入第三方企业数据

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
corpId	String	必须	ding3bc66654doxxx378f	钉钉企业ID
userId	String	必须	test01	员工ID
processCode	String	必须	PROC-3KYJW2FV-U8PN4EN7PUY50UX9****6J-2	审批模板唯一编码
action	String	必须	RENDER	表单渲染动作：RENDER, UPDATE, SUBMIT, 分别对应表单的初始化，内容更新以及提交前检查
form	RequestFormData	可选		表单数据
└ changedItem String 可选 userName 发生变化的 bizAlias items RequestFormItem [] 可选表单数据 └ extValue String 可选 [ {"avatar": "https://static.dingtalk.com/media/lADPBbCc1bX9vJvNDozNDow_3724_3724.jpg", "emplId": "0213523642832201", "name": "张三"}] 表单项扩展数据 └ value String 可选张三表单值 props RequestFormItemProperty 可选表单属性 └ bizAlias String 可选 userName 表单控件别名

响应参数

名称	类型	示例值	描述
data	ResponseFormData		表单数据以及默认选项等
items ResponseFormItem [] 表单数据 └ value String 胡XXX 表单值 └ extValue String [{"emplId":"manager1976","name":"胡XXX"}] 扩展属性，譬如联系人的通讯录信息 props ResponseFormItemProperty 表单属性 └ label String 加班人表单控件 label └ hidden Boolean false 是否不可见 └ disable Boolean false 是否不可编辑 └ options String [{"value":"事假","valueExt":{"typeId":5002,"typeName":"事假"] 选择框的选项列表，只有选择框需要此属性 └ bizAlias String userName 表单控件别名 children ResponseChildFormItem [] 明细组件，没有使用该控件则忽略 └ value String [{"rowValue":[{"label":"联系人","value":"涵远","bizAlias":"InnerContactField-JNU7Q8XQ","extendValue":[{"avatar":"https://static.dingtalk.com/.jpg","name":"涵远测试","emplId":"03141*7463"}]}]},{"rowValue":[{"label":"联系人","value":"尘舟","bizAlias":"InnerContactField-JNU7Q8XQ","extendValue":[{"avatar":"https://static.dingtalk.com/.jpg","name":"尘舟","emplId":"01065***4167"}]}]}] 表单值 └ extValue String {"statValue":[]} 扩展属性，譬如联系人的通讯录信息 props ResponseChildFormItemProperty 表单属性 └ label String 职务代理人表单控件 label └ disable Boolean false 是否不可编辑 └ bizAlias String userName 表单控件别名 └ linkageFormItems String ["userName","email"] 需要联动的表单项别名(bizAlias)
resultMessage	String	成功	返回错误消息
success	Boolean	true	业务是否成功
resultCode	String	0	返回错误码

请求示例

{"corpId":"ding3bc66654doxxx378f","form":{"changedItem":"userName","items":[{"value":"张三","extValue":"[ {\"avatar\": \"https://static.dingtalk.com/media/lADPBbCc1bX9vJvNDozNDow_3724_3724.jpg\", \"emplId\": \"0213523642832201\", \"name\": \"张三\"}]","props":{"bizAlias":"userName"}}]},"processCode":"PROC-3KYJW2FV-U8PN4EN7PUY50UX9****6J-2","action":"RENDER","userId":"test01"}

响应示例

{
    "data":{
        "items":[
            {
                    "value":"胡XXX",
                    "extValue":"[{\"emplId\":\"manager1976\",\"name\":\"胡XXX\"}]",
                    "props":{
                        "label":"加班人",
                        "hidden":false,
                        "disable":false,
                        "options":"[{\"value\":\"事假\",\"valueExt\":{\"typeId\":5002,\"typeName\":\"事假\"]",
                        "bizAlias":"userName"
                    },
                    "children":[
                        {
                                "value":"[{\"rowValue\":[{\"label\":\"联系人\",\"value\":\"涵远\",\"bizAlias\":\"InnerContactField-JNU7Q8XQ\",\"extendValue\":[{\"avatar\":\"https:\/\/static.dingtalk.com\/*.jpg\",\"name\":\"涵远测试\",\"emplId\":\"03141***7463\"}]}]},{\"rowValue\":[{\"label\":\"联系人\",\"value\":\"尘舟\",\"bizAlias\":\"InnerContactField-JNU7Q8XQ\",\"extendValue\":[{\"avatar\":\"https:\/\/static.dingtalk.com\/*.jpg\",\"name\":\"尘舟\",\"emplId\":\"01065***4167\"}]}]}]",
                                "extValue":"{\"statValue\":[]}",
                                "props":{
                                    "label":"职务代理人",
                                    "disable":false
                                },
                                "bizAlias":"userName"
                        }
                    ]
            }
        ],
        "linkageFormItems":"[\"userName\",\"email\"]"
    },
    "resultMessage":"成功",
    "success":true,
    "resultCode":"0"
}

验签示例

{"success":"false","resultCode":"sign-check-failure","resultMessage":"Illegal request"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

钉钉API

qimen.dingtalk.flow.form (钉钉审批开放表单)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ

用户导航

用户反馈

用户反馈

用户反馈