全球领先的SaaS智能营销云平台

< 文档首页

API文档

首页 > API文档 > CRM

CRM业务接口

更新时间： 2024-11-21 17:29:30

CRM业务接口

1.产品档案上下架

此接口仅支持 ProductObj 对象。

请求路径：https://open.71360.com/cgi/crm/data/changeShelfStatus

请求方式：post+application/json 方式

参数说明：

参数	类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	开放平台公司账号
currentOpenUserId	String	是	当前操作人的openUserId
apiName	String	是	对象的api_name
dataId	String	是	数据Id
status	int	是	上下架状态 1:上架、2:下架

请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_CB185C9B12F5403218CBABB2EFBB524A", 
    "apiName": "ProductObj", 
    "dataId": "f4d79eb2b56b469abf74cf48e119b07c", 
    “status": 1
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容

正确JSON 返回示例：
{
    "errorCode": 0,
    "errorMessage": "success"
}

错误JSON 返回示例：
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

2.订单确认已发货

此接口仅支持 SalesOrderObj 对象。

请求路径：https://open.71360.com/cgi/crm/data/confirmDelivery

请求方式：post+application/json 方式

参数说明：

参数	类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	开放平台公司账号
currentOpenUserId	String	是	当前操作人的openUserId
apiName	String	是	对象的api_name,只支持销售订单(SalesOrderObj)
dataId	String	是	数据Id,订单Id
deliveryComment	String	是	发货备注

请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "apiName": "SalesOrderObj",
    "currentOpenUserId": "FSUID_CB185C9B12F5403218CBABB2EFBB524A",
    "dataId": "DATAid1",
    "deliveryComment": "deliveryComment_remark"
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容

正确JSON 返回示例：
{
    "errorCode": 0,
    "errorMessage": "success"
}

错误JSON 返回示例：
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

3.订单确认已收货

请求路径：https://open.71360.com/cgi/crm/data/confirmReceive

请求方式：post+application/json 方式

参数说明：

参数	参数类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	企业ID
currentOpenUserId	String	是	当前操作人OpenUserID
apiName	String	是	对象的api_name,只支持销售订单(SalesOrderObj)
dataIds	List	是	订单Id

请求包结构体示例：

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "apiName": "SalesOrderObj", 
    "dataIds":["2267d122e36d4211ab0509996b324376"]
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容

a)正确的Json返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success"
}

b)错误的Json返回示例:

{
    "errorCode": 204110004,
    "errorMessage": "CRM-EX-SERVICE-VALID-WARN: ex-code:0 ex-message:销售订单XXX已收货,不允许重复收货"
}

4.商机切换销售流程

此接口仅支持 SaleActionObj对象。

请求路径：https://open.71360.com/cgi/crm/data/changeSalesProcess

请求方式：post+application/json 方式

参数说明：

参数	类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	开放平台公司账号
currentOpenUserId	String	是	当前操作人的openUserId
apiName	String	是	对象的api_name,只支持销售流程(SaleActionObj)
dataId	String	是	数据Id,销售流程Id
opportunityId	String	是	商机Id

请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN", 
    "corpId": "CORP_ID", 
    "currentOpenUserId": "FSUID_3818E17B8D18FA0476CE46BF046CE191", 
    "apiName": "SaleActionObj", 
    "dataId":"DATAid1",
    "opportunityId":"opportunityId1"
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容

正确JSON 返回示例：
{
    "errorCode": 0,
    "errorMessage": "success"
}

错误JSON 返回示例：
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

5.商机变更销售阶段

请求说明：

请求路径：https://open.71360.com/cgi/crm/data/changeSalesStage

请求方式：post+application/json 方式

参数说明：

参数	参数类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	企业ID
currentOpenUserId	String	是	当前操作人OpenUserID
apiName	String	是	对象的api_name,只支持销售流程(SaleActionObj)
opportunityId	String	是	商机Id
dataId	String	是	当前销售阶段Id
nextSaleStageId	String	是	待变更的销售阶段ID

请求包结构体示例：

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "apiName": "SaleActionObj", 
    "opportunityId":"51e16560fecf4188b12f4aacc0617cf5",
    "dataId":"8bcf14d0b78645f581149cba07c38bf6",
    "nextSaleStageId":"a22e144029c24958b5158fef5541c88e"
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容

a)正确的Json返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success"
}

b)错误的Json返回示例:

{
    "errorCode": 204110005,
    "errorMessage": "CRM-EX-SERVICE-VALID-WARN: ex-code:0 ex-message:销售流程已完成，无法变更。"
}

6.查询销售记录列表

请求路径：https://open.71360.com/cgi/crm/salesRecorder/query

请求方式：post+application/json 方式

参数说明：

参数	参数类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	企业ID
currentOpenUserId	String	是	当前操作人OpenUserID
apiName	String	是	关联的对象apiName
dataId	String	是	关联的对象数据Id
startTime	String	否	开始时间
endTime	String	否	结束时间
senderOpenUserId	String	否	发起人
pageSize	int	否	页面大小默认20
pageNumber	int	否	页码默认1

请求包结构体示例：

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "startTime":"1503273600000",
    "endTime":"1503381600000",
    "dataId":"c5121734b3904060af0f29bc8c9c3342",
    "apiName":"XXXObj"
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容
total	是	总记录数
salesRecorders	否	销售记录详情列表

a)正确的Json返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success",
    "total": 0,
    "salesRecorders": [
        {
            "id": 100620,
            "creatorOpenUserId": "FSUID_xxxxx",
            "createTime": 1503458730509,
            "relationObjects": [
                {
                    "apiName": "LeadsObj",
                    "dataId": "5ab36a460541498195f5a2290e40c859"
                }
            ],
            "salesRecorderType": 1,
            "content": "XXX",
            "salesRecorderType": "f7e89bacd81242d2b3a237b281e4e131",
            "attachmentList": [
                {
                    "id": "9e925da7-536b-4d72-ab72-cec3d9463428",
                    "type": 2,
                    "name": "XXXXX"
                }
            ],
            "openEmployeeIds": [
                "FSUID_XXXA",
                "FSUID_XXXB"
            ],
            "circleIds": [
                1000,
                1001,
                1002
            ]
        }
    ]
}

b)错误的Json返回示例:

{
    "errorCode": 20012,
    "errorMessage": "openUserId not found",
    "total": 0
}

7.获取销售记录详情

请求路径：https://open.71360.com/cgi/crm/salesRecorder/get

请求方式：post+application/json 方式

参数说明：

参数	参数类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	企业ID
currentOpenUserId	String	是	当前操作人OpenUserID
salesRecorderId	int	是	销售记录Id

请求包结构体示例：

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "salesRecorderId":6628
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容
total	是	总记录数
salesRecorders	否	销售记录详情

a)正确的Json返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success",
    "salesRecorder": {
        "id": 6628,
        "creatorOpenUserId": "FSUID_xxxxx",
        "createTime": 1503374595887,
        "relationObjects": [
            {
                "apiName": "d",
                "dataId": "h"
            }
        ],
        "content": "XXX",
        "salesRecorderType": "f7e89bacd81242d2b3a237b281e4e131",
        "attachmentList": [
            {
                "id": "9e925da7-536b-4d72-ab72-cec3d9463428",
                "type": 2,
                "name": "XXXXX"
            }
        ],
        "openEmployeeIds": [
           "FSUID_XXXA",
           "FSUID_XXXB"
        ],
        "circleIds": [
           1000,
           1001,
           1002
        ]
    }
}

b)错误的Json返回示例:

{
    "errorCode": 20012,
    "errorMessage": "openUserId not found",
    "total": 0
}

8.获取销售记录类型

请求路径：https://open.71360.com/cgi/crm/salesRecorderType/query

请求方式：post+application/json 方式

参数说明：

参数	参数类型	必须	备注
corpAccessToken	String	是	企业应用访问公司合法性凭证
corpId	String	是	企业ID
currentOpenUserId	String	是	当前操作人OpenUserID

请求包结构体示例：

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx"
}

返回说明：

参数	必须	说明
errorCode	是	返回码
errorMessage	是	对返回码的文本描述内容
salesRecorderTypes	否	销售记录类型

a)正确的Json返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success",
    "salesRecorderTypes": [
        {
            "id": "2c1d49a6d0bc4208a1e7bf6640f5b7ac",
            "name": "上门培训"
        },
        {
            "id": "71b416120ed24558bae640f1d880e8a2",
            "name": "视频辅导"
        },
        {
            "id": "2c161ab9c9994b44a106846566fe0382",
            "name": "上门维修"
        },
        {
            "id": "0cfff9c054a6411ead1535b771812b6f",
            "name": "客户投诉"
        },
        {
 &

相关文档