Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The ECM REST APIs allow to configure campaigns, strategies and insert contacts to a campaign. It currently supports the following functions:

...

Protocol

HTTP or HTTPS

URL

https://<UMM-FQDN>/umm/ecm/campaign/delete?id=1

AuthorizationBearer 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

404: Not found

500: Internal Server Error

503: Service Unavailable

Example Response


...

Protocol

HTTP or HTTPS

URL

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

AuthorizaitoionBearer token-from-login-API

Content-Type

Application/JSON

HTTP Method

POST

Input/Output Format

JSON

Request Body

  • csId: This is the strategy ID of which this attempt is a part.
  • name = this is the name of the attempt
  • phone: This defines on which phone 01-phone 05 this attempt should be made. The expected values are: i) 1= Phone 01, ii) 2 = Phone 02, iii) 3 = Phone 03, iv) 4 = Phone 04, v) 5 = Phone 05 
  • channel: This is the channel through which the attempt has to be made. The expected values are: i) 0 = Voice, ii) 1 = SMS
  • attempt number: This is the order of the attempt among the other attempts in the Strategy.
  • retry map: In case of a voice call attempt, the retry map is used to define what to do if the result of a voice call attempt is one of the following: 

    Value Call Result Description
    1Busy
    2No Answer
    3Customer Abandoned
    4Dialer Abandoned
    5Others-Not Connected: This includes all call results that were not connected due to any reason other than the above.


If the call result is one of the above, it allows to define which attempt should be made and after how much time.

Example:
[
 {
   "call_result":"1",→ Busy
   "attempt_number":"2",
   "attempt_delay":"30"
 },
]


This means if call_result = BUSY then go for attempt 2 and execute it after 30 minutes but if call_result is NO_ANSWER, close the record.

In the case of an SMS attempt, it allows defining what to do if there's no reply from the customer, ; i.e. whether the system should make another attempt or close the contact.

Example:
[
 {
   "sms_response_timeout":"30",
   "attemptIdattempt_number":"2",
   "expiry":"30"
 }
]
If the customer does not respond within 30 minutes, go for attempt 2.

HTTP Request


Code Block
titleExample Request
{
    "csId": 2,
    "name": "Default",
    "phone": "1",
    "channel": 0,
    "attemptNumber": 1,
    "retryMap": [
       {
          "attempt_number": 2,
          "delay": 10,
          "call_result": 2
      }
     ]
}


HTTP Response

200: Success

404: Not found

500: Internal Server Error

503: Service Unavailable

Example Response


Code Block
titleExample Response
{
    "id": 1,
	"csId": 2,
    "name": "Default",
    "phone": "1",
    "channel": 0,
    "attemptNumber": 1,
    "retryMap": [
       {
          "attempt_number": 2,
          "delay": 10,
          "call_result": 2
      }
     ]
}


...