应用推荐
该方法通过ID应用推荐，并返回每个请求推荐的成功与失败详情。
注意
请勿将此API路由用于允许访问请求类型的推荐。该功能将在后续版本中支持。
参数
|
名称 |
描述 |
包含于请求中 |
类型 |
取值 |
|---|---|---|---|---|
|
|
您要应用的推荐所属公司的ID。 |
可选 注意当应用来自其他公司的推荐时为必填项。 |
字符串 |
必须是一个您拥有管理权限的有效公司ID。 默认值：与用于请求的API密钥关联的公司ID。 |
|
|
您希望应用的推荐ID列表。 |
必填 |
字符串数组 |
必须是有效的推荐ID且归属于同一公司。 |
这些是公共API方法通用的参数。
|
参数 |
描述 |
包含于请求中 |
类型 |
取值 |
|---|---|---|---|---|
|
|
此参数为请求添加标识符，用于关联其对应响应。 目标方在响应中返回相同值，便于追踪调用。 |
必填 |
字符串 |
无附加要求 |
|
|
用于发送请求的方法名称。 |
必填 |
字符串 |
必须是有效的方法名称。 |
|
|
请求和响应所使用的JSON-RPC版本。 |
必填 |
整数 |
可选值：
|
|
|
包含请求配置的对象。 |
必填 |
对象 |
无额外要求。 |
|
在
|
||||
|
|
结果页码。 |
可选 |
整数 |
默认值：
|
|
|
每页显示的结果数量。 |
可选 |
整数 |
每页上限为100条。
默认值：
|
返回值
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
字符串数组 |
成功应用的推荐ID。 |
|
|
对象数组 |
每个对象包含未能成功应用的推荐信息。 |
对象
失败推荐
|
属性 |
类型 |
描述 |
|---|---|---|
|
|
字符串 |
推荐的唯一标识符。 |
|
|
字符串 |
尝试应用推荐时发生的错误描述。 |
|
|
整数 |
错误代码。 |
示例
请求 :
{
"params": {
"recommendationIds": [
"68480f4e11e8dc005bb0f9e7",
"6853e32b4783f7a2f15582c4",
"6853e32b4783f7a2f15582cf"
],
"companyId": "67fe8595d4db0d536908ec92"
},
"jsonrpc": "2.0",
"method": "applyRecommendations",
"id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890"
}
响应 :
{
"id": "b7e2c1d4-9f8a-4c2e-8b1a-ef1234567890",
"jsonrpc": "2.0",
"result": {
"appliedRecommendations": [],
"failedRecommendations": [
{
"recommendationId": "68480f4e11e8dc005bb0f9e7",
"error": "推荐已应用。",
"errorCode": 3432
},
{
"recommendationId": "6853e32b4783f7a2f15582c4",
"error": "推荐已应用。",
"errorCode": 3432
},
{
"recommendationId": "6853e32b4783f7a2f15582cf",
"error": "未找到推荐。",
"errorCode": 3432
}
]
}
}