/
.API Reference v13.3

.API Reference v13.3

Sept 12, 2021

The ECM REST APIs allow configuring resources such as campaigns, strategies, campaign contacts, and preference settings . It currently supports the following functions:

  • Manage Campaigns

  • Upload Contacts to campaigns

  • Insert DNC callers

  • Manage campaign strategies 

  • Define preference configurations



On this page:

Login

This API is used to get an access token that will be used as a bearer token in the rest of the APIs for authentication/authorization. This API also returns license and user details

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/api/login

Content-Type

Application/JSON

HTTP Method

GET

Input/Output Format

JSON

Request Body

  • username (required): The username to login to ECM

  • password (required): The password to login to ECM

Example Request

Example Request
{ "username":"admin", "password":"admin" }

HTTP Response

200: Success

400: Invalid request body

401: Unauthorized

404: Not found

405: HTTP method not allowed

500: Internal Server Error

503: Service Unavailable

Example Response

Example Response
{ "license":"valid", "licStatus":"trial", "licensedTo":"KPMG", "creationDate":"2019-09-16T19:00:00Z", "expiryDate":"2022-10-16T19:00:00Z", "supportExpiryDate":null, "numberOfAgents":5, "valid":true, "userDetails":{ "id":1, "username":"admin", "userId":null, "email":null, "fullName":"Administrator", "type":"DB", "isActive":true, "profileExists":false, "lastLogin":"Fri Jun 11 13:40:55 PKT 2021", "lastUpdated":"1623400855424", "dateCreated":"1615193443313", "createdBy":null, "updatedBy":null, "profilePicture":null, "roles":[{ "id":1, "name":"Administrator", "description":"Administrator Role", "permissions":null}]}, "token_type":"Bearer", "token":"JWT-TOKEN", "expires_in":36000, "refresh_token":"JWT-REFRESH-TOKEN" }



Campaign

Get Cisco Campaigns

This API fetches the Cisco campaigns from UCCE/UCCX.  A campaign from this list can be choosen to associated with ECM campaign in campaign create API

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/fetchCiscoCampaigns

Authorization

Bearer token retrieved from login API

Content-Type

Application/JSON

HTTP Method

GET

Input/Output Format

JSON

Request Parameters



HTTP Request

-

HTTP Response

200: Success

401: Not Authorized

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

In case of CCE: 

Example Response
[ { "ciscoCampaignId": "5001", "ciscoCampaignName": "IVR_based", "ciscoTableName": "DL_5002_5002", "ciscoFileName": "test.txt", "ciscoFilePath": "//Sprawler/import/", "campaignType": "0" } ]

In case of CCX response:

Example Response
[ { "ciscoCampaignId": "5001", "ciscoCampaignName": "IVR_based" "campaignType": "0" } ]

Create campaign

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/createCampaign

Authorization 

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

  • startTime (required): This is the start time of the campaign

  • endTime (required): This is the end time of the campaign

  • name (required): This is the name of the campaign.

  • description (optional): This is the optional description of the campaign 

  • strategyId (required): This is the ID of the strategy attached to the campaign.

  • type (required): This is the type of ECM campaign. This can be one of the following: i) IVR ii) Agent iii) None  where 0 = IVR, 1 = Agent and -1 = NONE

  • crmCampaignId (optional): This is the ID of the CRM campaign attached to this campaign.

  • ciscoCampaignId (required): This is the ID of the Cisco campaign attached to this campaign

  • weekDays (required): Select on which days of the week the campaign should run. The expected values are between 0-6 where 0 = Sunday and 6 = Saturday.

  • enabled (required): This is the status of the campaign. The expected value is either true OR false 

  • description (optional): This is an optional description of the campaign.

  • SMS template (optional): This is the template SMS that is attached to this campaign. This SMS is used for any SMS attempts in the strategy.

HTTP Request

Example Request
{ "startTime": "22:10", "endTime": "22:23", "name": "sample_campaign", "description": "details", "strategyId": "22", "status": "1", "type": "0", "crmCampaignId": "crm_campaign_1", "ciscoCampaignId": "5001", "weekDays": "0,1,2", "enabled": true, "description": "details", "smsTemplate": "sms-template" }

HTTP Response

201: Success

401: Not Authorized

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Example Response
{"id": "2", "crmCampaignId": "crm_campaign_1", "ciscoCampaignId": "5001", "ciscoCampaignName": "IVR_based", "smsTemplate": "sms template", "description": "details", "enabled": true, "endTime": "22:23", "strategyId": "22", "name": "sample_campaign", "startTIme": "22:10", "status": "1", "type": "0", "lastUpdated": "2018-11-14T11:01:42Z", "dateCreated": "2018-11-14T11:01:42Z", "weekdays": "0,1,2" }

Create Campaign by Skill Group

This API is used for creating a campaign in ECM using a UCCE skill group. The skill group name passed is JSON is used to associated UCCE campaign with ECM campaign

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/createCampaignBySkilllGroup

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

  • crmCampaignId (optional): ID of the CRM campaign which needs to be associated with this ECM campaign

  • name (required): This is the name of the ECM campaign

  • description (optional): This is the description of the ECM campaign

  • dialerType (optional): This is the dialing mode of the Cisco campaign which is supposed to be mapped with this ECM campaign. 

  • skillGroup (required): This is the CCE Skill Group attached to the associated Cisco campaign. 

  • enabled (required): This is the status of the campaign. The expected value is either true OR false 

  • endTime (required): This is the end time of the campaign execution. Once this time reaches, the campaign stops automatically. 

  • startTime (required): This is the start time of the campaign. 

  • strategyId (required): This is the ID of the strategy attached to this campaign.

  • type (required): This is the type of the ECM campaign. This can be one of the following: i) IVR ii) Agent iii) None  where 0 = IVR, 1 = Agent and -1 = NONE

  • weekDays (required): Select on which days of the week the campaign should run. The expected values are between 0-6 where 0 = Sunday and 6 = Saturday. 

  • SMS template (optional): This is the template SMS that is attached to this campaign. This SMS is used for any SMS attempts in the strategy.

HTTP Request

Example Request
{ "crmCampaignId":"1122", "name": "Agent_Camp", "description": null, "dialerType":"PREDICTIVE", "skillGroup": "skillGroupName", "enabled": true, "endTime": "23:30", "startTime": "00:00", "strategyId": 2, "type": 0, "weekDays": "0,1,2,3,6", }

HTTP Response

200: Success

401: Not Authorized

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Example Response
{"id": "2", "crmCampaignId": "1122", "ciscoCampaignId": "5001", "ciscoCampaignName": "IVR_based", "dialerType":"PREDICTIVE", "skillGroup": "skillGroupName", "smsTemplate": "sms template", "description": null, "enabled": true, "endTime": "23:30", "strategyId": "2", "name": "Agent_Camp", "startTime": "00:00", "status": "1", "type": "0", "lastUpdated": "2018-11-14T11:01:42Z", "dateCreated": "2018-11-14T11:01:42Z", "weekdays": "0,1,2,3,6" }

Update Campaign

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/update

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

PUT

Input/Output Format

JSON

Request Body

  • id: ECM campaign ID OR

  • crmCampaignId: CRM campaign ID associated with the ECM campaign

HTTP Request

Example Request
{ "id":1 "name":"updated name" }

HTTP Response

200: Success

401: Not Authorized

404: Not Found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Complete Campaign object with the updated values (Ref: Response of create campaign)

Get Campaigns List 

This will return the complete list of campaigns 

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

GET

Input/Output Format

JSON

Request Body



HTTP Request

 

HTTP Response

200: Success

401: Not Authorized

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Example Response
[ { "id": "2", "crmCampaignId": "crm_campaign_1", "ciscoCampaignId": "5001", "ciscoCampaignName": "IVR_based", "smsTemplate": "sms template", "description": "details", "enabled": true, "endTime": "22:23", "strategyId": "22", "name": "sample_campaign", "startTIme": "22:10", "status": "1", "type": "0", "lastUpdated": "2018-11-14T11:01:42Z", "dateCreated": "2018-11-14T11:01:42Z", "weekdays": "0,1,2" }, ... ]

Delete campaign

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



Campaign Status (Pause/Resume)

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/campaignUpdateStatus

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

  • campaignId: ECM campaign ID OR crmCampaignId: CRM campaign ID associated with the ECM campaign

  • status: True/False

HTTP Request



HTTP Response

200: Success

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Campaign with id successfully paused/resumed

DNC (Do Not Call)

This resource is used to update the DNC list in ECM so that the system does not dial contacts that are present in the DNC list. 

Get DNC Contacts

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/contact

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

GET

Input/Output Format

JSON

Request Parameters



HTTP Request



HTTP Response

200: Success

404: Not found

406: Not Acceptable

500: Internal Server Error

503: Service Unavailable

Example Response

Example Response
[ { "id": 1, "name": "David", "updateById": 1, "primaryNumber": "03062558180", "dataCreated": "2019-07-31T12:02:09Z", "lastUpdated": "2019-07-31T12:02:09Z" }, ... ]

Upload Single Contact to DNC

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/contact/save

Authorization

Bearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

  • name (required): This is the name of the contact

  • primaryNumber (required): This is the phone number of the contact 

HTTP Request

Example Request
{ "name": "David", "primaryNumber": "03062558180" }



HTTP Response

200: Success

404: Not found

406: Not Acceptable