获取通话记录对象描述接口
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": "ServiceRecordObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-9b742f31429c442a",
"data": {
"describe": {
"created_by": "1453",
"api_name": "ServiceRecordObj",
"display_name_r": "通话记录",
"short_name": "te1",
"fields": {
"lock_rule": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104148,
"description": "锁定规则",
"is_unique": false,
"default_value": "default_lock_rule",
"rules": [],
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "锁定规则",
"index_name": "s_1"
},
"service_tag": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104162,
"is_unique": false,
"label": "标签",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "service_tag",
"options": [
{
"not_usable": false,
"label": "投诉建议",
"value": "1001",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "咨询",
"value": "1002",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
},
{
"not_usable": false,
"label": "其他",
"value": "other",
"config": {
"edit": 1,
"enable": 1,
"remove": 1
}
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "标签",
"config": {
"add": 1,
"edit": 1,
"attrs": {
"options": 1,
"label": 1
}
},
"index_name": "s_2"
},
"customer_number": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104093,
"is_unique": false,
"label": "通话号码",
"type": "phone_number",
"is_need_convert": false,
"is_required": true,
"api_name": "customer_number",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "通话号码",
"index_name": "p_1"
},
"seat_id": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104093,
"pattern": "",
"is_unique": false,
"label": "坐席号",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "seat_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "坐席号",
"is_index_field": false,
"index_name": "t_1",
"max_length": 256
},
"origin": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104163,
"is_unique": false,
"label": "记录来源",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "origin",
"options": [
{
"not_usable": false,
"label": "呼叫中心",
"value": "1"
},
{
"not_usable": false,
"label": "CRM",
"value": "2"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "记录来源",
"index_name": "s_3",
"config": {}
},
"ringing_time": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104118,
"pattern": "",
"is_unique": false,
"label": "响铃时间",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "ringing_time",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "响铃时间",
"is_index_field": false,
"index_name": "t_2",
"max_length": 256
},
"lock_user": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104149,
"description": "加锁人",
"is_unique": false,
"label": "加锁人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_user",
"define_type": "package",
"is_index_field": false,
"is_single": true,
"index_name": "a_1"
},
"answer_status": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104165,
"is_unique": false,
"label": "通话状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "answer_status",
"options": [
{
"not_usable": false,
"label": "未接听",
"value": "0"
},
{
"not_usable": false,
"label": "通话中",
"value": "1"
},
{
"not_usable": false,
"label": "已接听",
"value": "2"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "通话状态",
"index_name": "s_4",
"config": {}
},
"service_note": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104142,
"pattern": "",
"is_unique": false,
"label": "通话备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "service_note",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "通话备注",
"index_name": "t_3",
"max_length": 1000
},
"extend_obj_data_id": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104143,
"pattern": "",
"is_unique": false,
"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_4",
"max_length": 256
},
"is_deleted": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"create_time": 1595301104331,
"is_unique": false,
"description": "is_deleted",
"default_value": false,
"label": "is_deleted",
"type": "true_or_false",
"is_need_convert": false,
"is_required": false,
"api_name": "is_deleted",
"define_type": "system",
"index_name": "is_del"
},
"is_saved": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104142,
"pattern": "",
"is_unique": false,
"label": "is_saved",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "is_saved",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "is_saved",
"is_index_field": false,
"index_name": "t_5",
"max_length": 256
},
"life_status_before_invalid": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104149,
"pattern": "",
"description": "作废前生命状态",
"is_unique": false,
"label": "作废前生命状态",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "life_status_before_invalid",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"index_name": "t_6",
"max_length": 256
},
"leads_obj_id": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104170,
"is_unique": false,
"label": "关联线索",
"target_api_name": "LeadsObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_cc_leads_obj_id",
"target_related_list_label": "通话记录",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "leads_obj_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "关联线索",
"is_index_field": true,
"index_name": "s_5"
},
"owner_department": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104143,
"pattern": "",
"is_unique": false,
"label": "负责人所在部门",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "owner_department",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "负责人所在部门",
"is_index_field": false,
"index_name": "owner_dept",
"max_length": 256
},
"out_owner": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104331,
"is_unique": false,
"label": "外部负责人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "out_owner",
"define_type": "system",
"is_single": true,
"index_name": "o_owner",
"config": {
"display": 1
}
},
"call_type": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104171,
"is_unique": false,
"label": "通话类型",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "call_type",
"options": [
{
"not_usable": false,
"label": "呼入",
"value": "0"
},
{
"not_usable": false,
"label": "呼出",
"value": "1"
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "通话类型",
"index_name": "s_6",
"config": {}
},
"owner": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104161,
"is_unique": false,
"label": "负责人",
"type": "employee",
"is_need_convert": false,
"is_required": true,
"api_name": "owner",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"label_r": "负责人",
"index_name": "owner"
},
"lock_status": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104148,
"description": "锁定状态",
"is_unique": false,
"default_value": "0",
"label": "锁定状态",
"type": "select_one",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_status",
"options": [
{
"label": "未锁定",
"value": "0"
},
{
"label": "锁定",
"value": "1"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "锁定状态",
"index_name": "s_7",
"config": {}
},
"last_modified_time": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"create_time": 1595301104331,
"is_unique": false,
"description": "last_modified_time",
"label": "最后修改时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "last_modified_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "md_time"
},
"create_time": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"create_time": 1595301104331,
"is_unique": false,
"description": "create_time",
"label": "创建时间",
"type": "date_time",
"time_zone": "",
"is_need_convert": false,
"is_required": false,
"api_name": "create_time",
"define_type": "system",
"date_format": "yyyy-MM-dd HH:mm:ss",
"index_name": "crt_time"
},
"life_status": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104149,
"description": "生命状态",
"is_unique": false,
"default_value": "normal",
"label": "生命状态",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "life_status",
"options": [
{
"label": "未生效",
"value": "ineffective"
},
{
"label": "审核中",
"value": "under_review"
},
{
"label": "正常",
"value": "normal"
},
{
"label": "变更中",
"value": "in_change"
},
{
"label": "作废",
"value": "invalid"
}
],
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "生命状态",
"index_name": "s_8",
"config": {}
},
"end_time": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104142,
"pattern": "",
"is_unique": false,
"label": "通话结束时间",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "end_time",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "通话结束时间",
"is_index_field": false,
"index_name": "t_7",
"max_length": 256
},
"record_file": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104142,
"is_unique": false,
"label": "录音文件",
"type": "url",
"is_need_convert": false,
"is_required": false,
"api_name": "record_file",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "录音文件",
"index_name": "w_1"
},
"last_modified_by": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104331,
"is_unique": false,
"label": "最后修改人",
"type": "employee",
"is_need_convert": true,
"is_required": false,
"api_name": "last_modified_by",
"define_type": "system",
"is_single": true,
"index_name": "md_by"
},
"contact_obj_id": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104164,
"is_unique": false,
"label": "关联联系人",
"target_api_name": "ContactObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_cc_contact_obj_id",
"target_related_list_label": "通话记录",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "contact_obj_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "关联联系人",
"is_index_field": true,
"index_name": "s_9"
},
"out_tenant_id": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104331,
"pattern": "",
"is_unique": false,
"description": "out_tenant_id",
"label": "外部企业",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "out_tenant_id",
"define_type": "system",
"index_name": "o_ei",
"config": {
"display": 0
},
"max_length": 200
},
"version": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"create_time": 1595301104331,
"length": 8,
"is_unique": false,
"description": "version",
"label": "version",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "version",
"define_type": "system",
"index_name": "version",
"round_mode": 4
},
"created_by": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104331,
"is_unique": false,
"label": "创建人",
"type": "employee",
"is_need_convert": true,
"is_required": false,
"api_name": "created_by",
"define_type": "system",
"is_single": true,
"index_name": "crt_by"
},
"relevant_team": {
"describe_api_name": "ServiceRecordObj",
"embedded_fields": {
"teamMemberEmployee": {
"is_index": true,
"is_need_convert": true,
"is_required": false,
"api_name": "teamMemberEmployee",
"is_unique": false,
"define_type": "package",
"description": "成员员工",
"label": "成员员工",
"type": "employee",
"is_single": true,
"help_text": "成员员工"
},
"teamMemberRole": {
"is_index": true,
"is_need_convert": false,
"is_required": false,
"api_name": "teamMemberRole",
"options": [
{
"label": "负责人",
"value": "1"
},
{
"label": "普通成员",
"value": "4"
}
],
"is_unique": false,
"define_type": "package",
"description": "成员角色",
"label": "成员角色",
"type": "select_one",
"help_text": "成员角色"
},
"teamMemberPermissionType": {
"is_index": true,
"is_need_convert": false,
"is_required": false,
"api_name": "teamMemberPermissionType",
"options": [
{
"label": "只读",
"value": "1"
},
{
"label": "读写",
"value": "2"
}
],
"is_unique": false,
"define_type": "package",
"description": "成员权限类型",
"label": "成员权限类型",
"type": "select_one",
"help_text": "成员权限类型"
}
},
"is_index": true,
"is_active": true,
"create_time": 1595301104172,
"is_unique": false,
"label": "相关团队",
"type": "embedded_object_list",
"is_need_convert": false,
"is_required": false,
"api_name": "relevant_team",
"define_type": "package",
"is_index_field": false,
"is_single": false,
"label_r": "相关团队",
"index_name": "a_team",
"help_text": "相关团队"
},
"record_type": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104166,
"description": "record_type",
"is_unique": false,
"label": "业务类型",
"type": "record_type",
"is_need_convert": false,
"is_required": false,
"api_name": "record_type",
"options": [
{
"is_active": true,
"api_name": "default__c",
"label": "预设业务类型",
"config": {
"enable": 0
}
}
],
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "业务类型",
"index_name": "r_type",
"config": {}
},
"call_id": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104095,
"pattern": "",
"is_unique": false,
"label": "通话记录ID",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "call_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "通话记录ID",
"is_index_field": false,
"index_name": "t_8",
"max_length": 256
},
"start_time": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104142,
"pattern": "",
"is_unique": false,
"label": "通话开始时间",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "start_time",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "通话开始时间",
"is_index_field": false,
"index_name": "t_9",
"max_length": 256
},
"account_id": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104093,
"pattern": "",
"is_unique": false,
"label": "企业编号",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "account_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "企业编号",
"is_index_field": false,
"index_name": "t_10",
"max_length": 256
},
"data_own_department": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104331,
"is_unique": false,
"label": "归属部门",
"type": "department",
"is_need_convert": false,
"is_required": false,
"api_name": "data_own_department",
"define_type": "package",
"is_single": true,
"index_name": "data_owner_dept_id"
},
"kf_number": {
"describe_api_name": "ServiceRecordObj",
"default_is_expression": false,
"is_index": true,
"is_active": true,
"create_time": 1595301104093,
"pattern": "",
"is_unique": false,
"label": "客服电话",
"type": "text",
"default_to_zero": false,
"is_need_convert": false,
"is_required": false,
"api_name": "kf_number",
"define_type": "package",
"is_extend": false,
"is_single": false,
"is_index_field": false,
"index_name": "t_11",
"max_length": 256
},
"account_obj_id": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104168,
"is_unique": false,
"label": "关联客户",
"target_api_name": "AccountObj",
"type": "object_reference",
"target_related_list_name": "target_related_list_cc_account_obj_id",
"target_related_list_label": "通话记录",
"action_on_target_delete": "set_null",
"is_need_convert": false,
"is_required": false,
"api_name": "account_obj_id",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "关联客户",
"is_index_field": true,
"index_name": "s_10"
},
"bridge_time": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104167,
"length": 18,
"is_unique": false,
"label": "通话时长",
"type": "number",
"decimal_places": 0,
"default_to_zero": true,
"is_need_convert": false,
"is_required": false,
"api_name": "bridge_time",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "通话时长",
"is_index_field": false,
"index_name": "d_1",
"round_mode": 4
},
"name": {
"describe_api_name": "ServiceRecordObj",
"is_index": true,
"is_active": true,
"create_time": 1595301104143,
"prefix": "{yyyy}{mm}{dd}-",
"is_unique": true,
"start_number": 1,
"serial_number": 4,
"label": "通话记录编号",
"type": "auto_number",
"condition": "NONE",
"is_need_convert": false,
"is_required": true,
"api_name": "name",
"define_type": "system",
"postfix": "",
"is_extend": false,
"is_single": false,
"label_r": "通话记录编号",
"is_index_field": false,
"index_name": "name"
},
"order_by": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"create_time": 1595301104331,
"length": 8,
"is_unique": false,
"description": "order_by",
"label": "order_by",
"type": "number",
"decimal_places": 0,
"is_need_convert": false,
"is_required": false,
"api_name": "order_by",
"define_type": "system",
"index_name": "l_by",
"round_mode": 4
},
"_id": {
"describe_api_name": "ServiceRecordObj",
"is_index": false,
"is_active": true,
"create_time": 1595301104331,
"pattern": "",
"is_unique": false,
"description": "_id",
"label": "_id",
"type": "text",
"is_need_convert": false,
"is_required": false,
"api_name": "_id",
"define_type": "system",
"index_name": "_id",
"max_length": 200
}
}
},
"detailObjectDescribeList": []
},
"errorDescription": "success",
"errorMessage": "success",
"errorCode": 0
}请求参数
Body 参数application/json
返回响应
扫码加入交流群修改于 2022-02-23 08:03:41