Bes_Open_API_English
  1. Table Structure
Bes_Open_API_English
  • Development guideline
    • BesChannels Product Overview
    • Log Update
  • Authentication
    • openapi-Get token
      POST
  • Leads
    • Get Leads List
      POST
    • Get Leads Details
      POST
    • Leads Create/Add
      POST
    • Leads Edit
      POST
    • Leads Delete
      POST
    • Get List of Remark
      POST
    • Add Remarks
      GET
    • Leads Assignment
      POST
    • Get Leads Activities & Attributes
      POST
    • Get Leads Behaviors
      POST
  • Contents
    • Get Content List
      POST
  • Events
    • Get Events List
      POST
  • Table Structure
    • Application acquiry
      POST
    • Table Structure List
      POST
    • Table Structure Details
      POST
  • Behaviors-NEW
    • Add Application
      POST
    • Add Activities
      GET
    • Get Activities
      POST
    • Get Activities Attributes
      POST
    • Add Activities Attributes
      POST
    • Add Users Behaviors
      POST
  • Others
    • Error code
  1. Table Structure

Table Structure Details

Developing
POST
/cdp/open-api/detail
客户数据平台(CDP)/CDP/表结构

Request

Query Params
access_token
string 
optional
Body Params multipart/form-data
id
string 
optional
表结构ID:id/schema_name必须传一个
Example:
1
schema_name
string 
optional
表结构名称:id/schema_name必须传一个
Example:
Marketing

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi.beschannels.com/cdp/open-api/detail?access_token' \
--form 'id="1"' \
--form 'schema_name="Marketing"'

Responses

🟢200success
application/json
Body
code
integer 
required
msg
string 
required
data
object 
required
id
integer 
required
org_id
string 
required
schema_name
string 
required
display_name
string 
required
template_id
integer 
required
description
string 
required
is_input_data
integer 
required
is_used
integer 
required
is_customer
integer 
required
schema_type
integer 
required
is_del
integer 
required
creator
string 
required
create_time
integer 
required
modifier
string 
required
modify_time
integer 
required
schema_type_desc
string 
required
schema_field
array [object {25}] 
required
Example
{
    "code": 0,
    "msg": "成功",
    "data": {
        "id": 214,
        "org_id": "org5d31bcdbd4f5f66feaeb990e06d31b23",
        "schema_name": "miniprogram",
        "display_name": "小程序",
        "template_id": 0,
        "description": "",
        "is_input_data": 2,
        "is_used": 2,
        "is_customer": 2,
        "schema_type": 2,
        "is_del": 1,
        "creator": "王凤建",
        "create_time": 1668060293,
        "modifier": "王凤建",
        "modify_time": 1668060711,
        "schema_type_desc": "",
        "schema_field": [
            {
                "id": 6656,
                "add_rule": [],
                "default_value": "",
                "description": "",
                "display_name": "unionid",
                "field_name": "unionid_wechat",
                "field_parent_id": 0,
                "field_type": "Text",
                "identity_field_id": "UnionID",
                "is_field_group": 1,
                "is_identity": 2,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": {
                    "min": "",
                    "max": ""
                },
                "options": [],
                "placeholder": "",
                "primary_identity": 2,
                "schema_id": 214,
                "sort": 1,
                "is_system": 2,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "",
                "forbid_manual_input_company": 0
            },
            {
                "id": 6657,
                "add_rule": [],
                "default_value": "",
                "description": "",
                "display_name": "小程序openid",
                "field_name": "mini_openid",
                "field_parent_id": 0,
                "field_type": "Text",
                "identity_field_id": "",
                "is_field_group": 1,
                "is_identity": 1,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": {
                    "min": "",
                    "max": ""
                },
                "options": [],
                "placeholder": "",
                "primary_identity": 1,
                "schema_id": 214,
                "sort": 2,
                "is_system": 2,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "",
                "forbid_manual_input_company": 0
            },
            {
                "id": 6658,
                "add_rule": [],
                "default_value": "",
                "description": "",
                "display_name": "手机号",
                "field_name": "phonemini",
                "field_parent_id": 0,
                "field_type": "Text",
                "identity_field_id": "PhoneNumber",
                "is_field_group": 1,
                "is_identity": 2,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": {
                    "min": "",
                    "max": ""
                },
                "options": [],
                "placeholder": "",
                "primary_identity": 1,
                "schema_id": 214,
                "sort": 3,
                "is_system": 2,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "",
                "forbid_manual_input_company": 0
            },
            {
                "id": 6659,
                "add_rule": [],
                "default_value": "",
                "description": "",
                "display_name": "小程序昵称",
                "field_name": "name2",
                "field_parent_id": 0,
                "field_type": "Text",
                "identity_field_id": "",
                "is_field_group": 1,
                "is_identity": 1,
                "is_option": 1,
                "is_required": 1,
                "minus_rule": [],
                "num_range": {
                    "min": "",
                    "max": ""
                },
                "options": [],
                "placeholder": "",
                "primary_identity": 1,
                "schema_id": 214,
                "sort": 4,
                "is_system": 2,
                "field_category": "",
                "field_editor_type": "",
                "group_editor_type": "",
                "forbid_manual_input_company": 0
            }
        ]
    }
}
Modified at 2023-06-07 11:25:45
Previous
Table Structure List
Next
Add Application
Built with