SAAS saas_plat openapi customer_fields

查询客户字段接口

查询客户字段接口

• URL：https://app.nxcloud.com/saas_plat/openapi/customer_fields
• Method：get
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，签名算法

Params参数：

参数名	类型	必选	示例值	说明
tenant_id	integer	是	123	租户id
is_preset	boolean	否	-	非必须，true：系统预置，false：非系统预置，不传展示全部

响应参数

参数名	类型	说明
code	Integer	结果编码
data	array	请求结果
message	String	请求结果说明
traceId	String	链路追踪ID

• data array参数：

参数名	类型	说明
id	Integer	id
tenantId	Integer	租户id
name	String	字段名称
display_name	String	显示名称
display_en_name	String	显示英文名称
is_display	Boolean	是否显示
field_type	Integer	字段类型
required	Boolean	是否必填
sequence	String	字段顺序
remark	String	备注
field_type_info	String	字段类型定义信息
is_preset	Boolean	是否系统预置

响应示例

成功示例

{
    "code": "82",
    "message": "quis anim",
    "traceId": "66",
    "data": [
        {
            "id": 48,
            "tenantId": 36,
            "field_type": 49,
            "remark": "ut Excepteur cupidatat labore",
            "sequence": 9,
            "is_preset": true,
            "is_display": true,
            "display_en_name": "说最与般也料",
            "display_name": "日统则心率厂",
            "name": "细才然素间表",
            "required": false,
            "field_type_info": "do est ex eu"
        }
    ]
}