The ECM REST APIs allow configuring resources such as campaigns, strategies, campaign contacts, and preference settings . It currently supports the following functions:
...
Protocol | HTTP or HTTPS |
|---|
URL | https://<UMM-FQDN>/umm/ecm/campaign/delete?id=1 |
|---|
| Authorization | Bearer token-from-login-API |
|---|
Content-Type | Application/JSON |
|---|
HTTP Method | DELETE |
|---|
Input/Output Format | JSON |
|---|
Request Parameters | - id: ECM campaign ID OR
- crmCampaignId: CRM campaign ID associated with the ECM campaign
|
|---|
HTTP Request | |
|---|
HTTP Response | 200: Success 401: Not Authorized 404: Not found 406: Not Acceptable 500: Internal Server Error 503: Service Unavailable |
|---|
Example Response | |
|---|
...
Protocol | HTTP or HTTPS |
|---|
URL | https://<UMM-FQDN>/umm/ecm/preferenceSettings/save |
|---|
| Authorizaitoion | Bearer token-from-login-API |
|---|
Content-Type | Application/JSON |
|---|
HTTP Method | POST |
|---|
Input/Output Format | JSON |
|---|
Request Body | |
|---|
HTTP Request |
| Code Block |
|---|
| {
"campaignBatchSize": 22,
"ivrBatchSize": 33,
"filePath": "path/to/file",
"fileArchivePath": "path/to/archive/folder",
"username": "admin", (For DB connectivity)
"password": "admin", (For DB connectivity)
"domainDomain" : "DbDomain"
}
|
|
|---|
HTTP Response | 200: Success 404: Not found 406: Not Acceptable 500: Internal Server Error 503: Service Unavailable |
|---|
Example Response |
| Code Block |
|---|
| {
"id": 1,
"campaignBatchSize": 22,
(This field describes the size of contacts. how many contacts will be used/added during each cycle of feed. If no size is provided by default it will assign value 10)
"ivrBatchSize": 33, (Same as above)
"filePath": "path/to/file",
(This field describes the path from where file will be fetched to get contacts and it is used in sync process. In sync process contacts uploaded to cisco to start campaign.)
"fileArchivePath": "path/to/file",
(This field describes the path where to extract file and place contacts)
"username": "admin", (For DB connectivity)
"password": "admin", (For DB connectivity)
"Domain" : "DbDomain"
}
|
|
|---|
...
Protocol | HTTP or HTTPS |
|---|
URL | https://<UMM-FQDN>/umm/ecm/preferenceSettings/update |
|---|
| Authorizaitoion | Bearer token-from-login-API |
|---|
Content-Type | Application/JSON |
|---|
HTTP Method | POST |
|---|
Input/Output Format | JSON |
|---|
Request Body | |
|---|
HTTP Request |
| Code Block |
|---|
| {
"id": 1
"campaignBatchSize": 22,
"ivrBatchSize": 33,
"filePath": "path/to/file",
"fileArchivePath": "path/to/archive/folder",
"username": "admin", (For DB connectivity)
"password": "admin", (For DB connectivity)
"domainDomain" : "DbDomain"
}
|
|
|---|
HTTP Response | 200: Success 404: Not found 406: Not Acceptable 500: Internal Server Error 503: Service Unavailable |
|---|
Example Response |
| Code Block |
|---|
| {
"id": 1,
"campaignBatchSize": 22,
(This field describes the size of contacts. how many contacts will be used/added during each cycle of feed. If no size is provided by default it will assign value 10)
"ivrBatchSize": 33, (Same as above)
"filePath": "path/to/file",
(This field describes the path from where file will be fetched to get contacts and it is used in sync process. In sync process contacts uploaded to cisco to start campaign.)
"fileArchivePath": "path/to/file",
(This field describes the path where to extract file and place contacts)
"username": "admin", (For DB connectivity)
"password": "admin", (For DB connectivity)
"Domain" : "DbDomain"
}
|
|
|---|
...
