获取微信粉丝对象描述接口
POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
"corpAccessToken": "${corpAccessToken}",
"corpId": "${corpId}",
"currentOpenUserId": "${currentOpenUserId}",
"includeDetail": true,
"apiName": "WechatFanObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-6301aba6f67e450e",
"data": {
"describe": {
"created_by": "-10000",
"icon_index": 0,
"api_name": "WechatFanObj",
"icon_path": "",
"fields": {
"country": {
"describe_api_name": "WechatFanObj",
"is_index": true,
"is_active": true,
"create_time": 1594630314196,
"is_unique": false,
"label": "国家",
"type": "country",
"used_in": "component",
"is_need_convert": false,
"is_required": false,
"api_name": "country",
"options": [],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "s_1",
"config": {}
},
"lock_rule": {
"describe_api_name": "WechatFanObj",
"is_index": true,
"is_active": true,
"create_time": 1594630314197,
"is_unique": false,
"rules": [],
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"index_name": "s_2",
"help_text": ""
},
"attention_status": {
"describe_api_name": "WechatFanObj",
"is_index": true,
"is_active": true,
"create_time": 1594630314198,
"is_unique": false,
"default_value": "",
"label": "关注状态",
"type": "select_one",
"is_required": false,
"api_name": "attention_status",
"options": [
{
"not_usable": false,
"label": "已关注",
"value": "attention",
"config": {
"edit": 0,
"enable": 0,
"remove": 0
}
},
{
"not_usable": false,
"label": "取消关注",
"value": "cancel_attention",
"config": {
"edit": 0,
"enable": 0,
"remove": 0
}
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"config": {
"add": 0,
"edit": 0,
"enable": 0,
"display": 1,
"remove": 0,
"attrs": {
"api_name": 0,
"options": 0,
"is_unique": 0,
"default_value": 0,
"label": 0,
"help_text": 0
}
},
"index_name": "s_5",
"help_text": ""
},
"extend_obj_data_id": {
"describe_api_name": "WechatFanObj",
"default_is_expression": false,
"is_index": false,
"is_active": true,
"create_time": 1594630314199,
"pattern": "",
"is_unique": false,
"default_value": "",
"label": "extend_obj_data_id",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "extend_obj_data_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "t_3",
"max_length": 100,
"help_text": ""
},
"province": {
"describe_api_name": "WechatFanObj",
"is_index": true,
请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-03-02 06:37:33