Marketing API
create coupon -wjb.ump.coupon.add
Description
get the the third party created coupon in CRM system
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | coupon | UmpCoupon | coupon detail | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
delete coupon -wjb.ump.coupon.delete
Description
delete already created coupon
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | coupon_id | Number | couponID | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
coupon query -wjb.ump.coupon.list
Description
query exists coupon list in system
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | start_time | Date | create begin time，yyyy-MM-dd hh:mm:ss | N |
| 2 | end_time | Date | create end time，yyyy-MM-dd hh:mm:ss，（end_time-start_time）<30days | N |
| 3 | page_no | Number | page number （>0），default1 | N |
| 4 | page_size | Number | page size <= 50，default10 | N |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
| 3 | coupons | UmpCoupon[] | coupon list |
| 4 | Total_result | Number | total record count |
coupon provide（SPI API）
Description
coupon issue API is provided by the third party,WangJuBao CRM call this API and send coupon.In SPI API,the input and return params are below:
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | coupon_id | Number | couponID | Y |
| 2 | buyer_nicks | String[] | nick list，no more than 50 | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
| 3 | send_results | CouponResult[] | send result list |
create marketing activity -wjb.ump.activity.add
Description
create a single marketing activity
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | activity | UmpActivity | marketing activity detail | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
| 3 | activity_id | Number | marketing activity id |
modify marketing activity -wjb.ump.activity.modify
Description
modify single marketing activity
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | activity | UmpActivity | marketing activity detail | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
delete marketing activity -wjb.ump.activity.delete
Description
delete single marketing activity
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | activity_id | Number | marketing activity ID | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
query marketing activity list -wjb.ump.activity.list
Description
query created marketing activity list，only limit to created marketing activity by API
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | start_time | Date | create begin time，yyyy-MM-dd hh:mm:ss | N |
| 2 | end_time | Date | create end time，yyyy-MM-dd hh:mm:ss，（end_time-start_time）<30days | N |
| 3 | page_no | Number | page number （>0），default1 | N |
| 4 | page_size | Number | page size <= 50，default10 | N |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
| 3 | activities | UmpActivity[] | marketing activity list |
| 4 | has_next | Boolean | has next page or not |
marketing target add -wjb.ump.activity.target.add
Description
add marketing activity target list
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | targets | UmpActivityTargets | marketing activity people | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |
marketing target clear -wjb.ump.activity.target.clear
Description
clear marketing activity target list
input params
| ID | Name | Type | Description | Required |
|---|---|---|---|---|
| 1 | activity_id | Number | activity ID | Y |
return
| ID | Name | Type | Description |
|---|---|---|---|
| 1 | code | Number | result code：0 success |
| 2 | error_message | String | error message |