ECM Developer Guide

Table of Contents

1. Overview

ECM APIs offer RESTful APIs for configuration of campaigns within ECM. Each object supports five methods (except where documented otherwise) that can be invoked on the URL that is associated with the object.

1.1. Version information

Version : 11.1.18

1.2. URI scheme

BasePath : /efadminpanel
Schemes : HTTP

1.3. Tags

  • Login : Login process

  • Campaign : Campaigns process

  • DNC : Do Not Call List

  • Call Strategies : Call Strategies – Redial Attempts

1.4. Produces

  • application/json

2. Resources

2.1. Login

Login process

2.1.1. Login

POST /auth/signIn
Description

This API would be used to login user into the application with specified credentials.

Parameters
Type Name Description Schema

Query

password
required

Password for being logged in the application

string

Query

username
required

Username for being logged in the application

string

Responses
HTTP Code Description Schema

200

Logged in Successfully

userLoginSuccessfully

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Example HTTP request
Request path
/auth/signIn
Request query
{
  "password" : "string",
  "username" : "string"
}
Example HTTP response
Response 200
{
  "token" : "eyJhbGciOiJSUzI1NiJ",
  "username" : "admin",
  "id" : 1,
  "email" : "[email protected]"
}

2.2. Campaign

Campaigns process

2.2.1. Get campaigns detail

GET /Campaign
Description

This API would be used to fetch complete details of campaign.

Responses
HTTP Code Description Schema

200

Operation Completed Successfully

showCampaignSuccessResponse

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign
Example HTTP response
Response 200
[ {
  "class" : "com.app.ef.ecm.Campaign",
  "id" : 2,
  "crmCampaignId" : "1122",
  "ciscoCampaignId" : "8",
  "ciscoCampaignName" : "QA_IVR",
  "createTime" : null,
  "description" : null,
  "enabled" : true,
  "endTime" : "23:30",
  "fedContacts" : null,
  "name" : "QA_IVR",
  "startTime" : "00:00",
  "status" : 1,
  "threshold" : 1,
  "type" : 1,
  "updateTime" : null,
  "weekDays" : "0,1,2,3,4,5,6"
} ]

2.2.2. Deletes an existing campaign

DELETE /Campaign/delete
Description

Deletes a campaign against a particular id or crmCampaignId

Parameters
Type Name Description Schema

Query

id
required

Id or crmCampaignId of campaign to be deleted

string (integer)

Responses
HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign/delete
Request query
{
  "id" : "string"
}

2.2.3. Updates an Existing Campaign

PUT /Campaign/editCampaign
Description

Two Ids can be passed to this API called id and crmCampaignId.If id is not null then API assumes to find ECM campaign with id=value in id parameter and if crmCampaignId is not null then API will search for campaign with crmCampaignId=value in parameter.

Parameters
Type Name Description Schema

Body

ciscoCampaignId
required

Campaign to be updated on the basis of crmCampaignId or Id provided

editCampaignParameters

Responses
HTTP Code Description Schema

200

Campaign Updated Successfully

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign/editCampaign
Request body
{
  "ciscoCampaignId" : 22,
  "crmCampaignId" : "1122",
  "id" : 2,
  "description" : "null",
  "enabled" : true,
  "endTime" : "23:00",
  "name" : "QA_IVR",
  "startTime" : "00:00",
  "strategyId" : 2,
  "type" : 0,
  "weekdays" : "0,1,2,3,6",
  "smsTemplate" : " "
}

2.2.4. Get CCX/CCE campaigns

GET /Campaign/fetchCiscoCampaigns
Description

Use this API call to get a list of all available campaigns on Cisco side to be sent in the createCampaign API.

Responses
HTTP Code Description Schema

200

All UCCE and UCCX Cisco Campaigns are Fetched

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign/fetchCiscoCampaigns
Example HTTP response
Response 200
[ {
  "ciscCampaignId" : "12",
  "ciscoCampaignName" : "IVR_CampR",
  "ciscoTableName" : "agent_as",
  "ciscoFileName" : "agent_1",
  "ciscoFilePath" : "file/agent_1",
  "campaignType" : "1"
} ]

2.2.5. Pause the specifeid campaign by id

POST /Campaign/pause
Description

This API function is used to pause an active campaign. Two Ids can be passed to this API called id and crmCampaignId. If id is not null then API assumes to find ECM campaign with id=value in id parameter and if crmCampaignId is not null then API will search for campaign with crmCampaignId=value in parameter and pauses it. If both are not null then API will check against id field. If both are passed null then error is thrown and if there is no campaign associated with any of the Ids then error is thrown. You can pass parameters to specify any filter for partially pausing a campaign.

Parameters
Type Name Description Schema

Body

Pause campaign
required

Key Value pair required to Pause campaign on the basis of id or crmCampaignId

campaignKeyValueParams

Responses
HTTP Code Description Schema

204

Campaign Paused

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign/pause
Request body
{
  "key" : "businessParam3",
  "value" : "5"
}

2.2.6. Resume the campaign

POST /Campaign/resume
Description

This API function is called to resume a paused campaign. Two Ids can be passed to this API called id and crmCampaignId. If id is not null then API assumes to find ECM campaign with id=value in id parameter and if crmCampaignId is not null then API will search for campaign with crmCampaignId=value in parameter and resumes it. If both are not null then API will check against id field. If both are passed null then error is thrown and if there is no campaign associated with any of the Ids then error is thrown. You can pass parameters to specify any filter for resuming a campaign. If no filter is specified, the whole campaign is resumed.

Parameters
Type Name Description Schema

Body

Resume Campaign
required

Key Value pair required to Resume campaign on the basis of id or crmCampaignId

campaignKeyValueParams

Responses
HTTP Code Description Schema

204

Campaign Resumed

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/Campaign/resume
Request body
{
  "key" : "businessParam3",
  "value" : "5"
}

2.2.7. Create a new campaign

POST /campaign/createCampaign
Description

Process of creating a campaign

Parameters
Type Name Description Schema

Body

Campaign
required

In case of UCCX only ciscoCampaignId is required while in case of UCCE all last three are required along with ciscoCampaignId. CiscoCampaignName is optional in both cases.

createCampaign

Responses
HTTP Code Description Schema

201

Campaign is created without any issue.

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/campaign/createCampaign
Request body
{
  "endTime" : "23:30",
  "name" : "Agent_Camp",
  "startTime" : "00:00",
  "strategyId" : 2,
  "type" : 0,
  "ciscoCampaignId" : 123,
  "ciscoCampaignName" : "TEST_OB",
  "weekDays" : "0,1,2,3,6",
  "enabled" : true,
  "description" : "null",
  "smsTemplate" : "",
  "ciscoFileName" : "test.txt",
  "ciscoFilePath" : "any/path",
  "ciscoTableName" : "5001_5002"
}

2.2.8. Create a new Campaign BY SKILL GROUP

POST /campaign/createCampaignBySkillGroup
Description

Process of creating a campaign by skill group only for UCCE

Parameters
Type Name Description Schema

Body

campaign
required

All attributes required to create a campaign by skill group

createCampaignBySkillGroup

Responses
HTTP Code Description Schema

201

If campaign is created without any issue

campaignBySkillGroupResponse

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

If there is no campaign found for (specified skill group and dialertype) or if crmCampaignId is not requested

campaignBySkillGroupErrorOne

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/campaign/createCampaignBySkillGroup
Request body
{
  "endTime" : "23:00",
  "name" : "Agent_Camp",
  "startTime" : "00:00",
  "strategyId" : 2,
  "dialerType" : "PREDECTIVE",
  "skillGroup" : "SkillGroupName",
  "crmCampaignId" : "1122",
  "enabled" : true,
  "weekDays" : "0,1,2,3,6",
  "smsTemplate" : "",
  "type" : 0,
  "description" : "null"
}
Example HTTP response
Response 201
{ }
Response 406
{ }

2.3. DNC

Do Not Call List

2.3.1. Inserts a caller

POST /callback/insertCallback
Description

This API is used for inserting a new caller.

Parameters
Type Name Schema

Query

businessParam1
optional

string

Query

businessParam10
optional

string

Query

businessParam11
optional

string

Query

businessParam12
optional

string

Query

businessParam2
optional

string

Query

businessParam3
optional

string

Query

businessParam4
optional

string

Query

businessParam5
optional

string

Query

businessParam6
optional

string

Query

businessParam7
optional

string

Query

businessParam8
optional

string

Query

businessParam9
optional

string

Query

campaignId
required

integer

Query

crmCampaignId
required

integer

Query

dialTime
optional

string

Query

phone1
required

string

Query

phone2
optional

string

Query

phone3
optional

string

Query

phone4
optional

string

Query

phone5
optional

string

Responses
HTTP Code Description Schema

200

Success Response

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callback/insertCallback
Request query
{
  "businessParam1" : "string",
  "businessParam10" : "string",
  "businessParam11" : "string",
  "businessParam12" : "string",
  "businessParam2" : "string",
  "businessParam3" : "string",
  "businessParam4" : "string",
  "businessParam5" : "string",
  "businessParam6" : "string",
  "businessParam7" : "string",
  "businessParam8" : "string",
  "businessParam9" : "string",
  "campaignId" : 0,
  "crmCampaignId" : 0,
  "dialTime" : "string",
  "phone1" : "string",
  "phone2" : "string",
  "phone3" : "string",
  "phone4" : "string",
  "phone5" : "string"
}
Example HTTP response
Response 200
{
  "status" : {
    "enumType" : "org.springframework.http.HttpStatus",
    "name" : "OK"
  },
  "statusString" : "Callback data saved"
}

2.3.2. Inserts Bulk callers

POST /callback/uploadBulkCaller
Description

This API inserts multiple records in bulk by parsing a CSV file attached with the API call.The file is attached to API call as multipart request entity in parameters.

Parameters
Type Name Description Schema

FormData

campaignId
optional

crmCampaignId or ecmCampaignId

string

FormData

file
optional

The file to upload.

file

Responses
HTTP Code Description Schema

200

If the file is successfully uploaded.

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

-If no campaign found for specified campaignId in request. <br> -If no id specified in the request.<br> -If the uploaded file is not CSV or txt format. <br>-If no file specify in the request.

No Content

500

Internal Server Error

No Content

Consumes
  • multipart/form-data

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callback/uploadBulkCaller
Request formData
"file"
Example HTTP response
Response 200
[ {
  "statusString" : "File is uploading."
} ]
Response 406
[ {
  "statusString" : "campaign not found for campaignId 14"
}, {
  "statusString" : "campaign id is null, not in parameters"
}, {
  "statusString" : "Please choose only the csv files!."
}, {
  "statusString" : "File is empty."
} ]

2.3.3. Inserts Sync Bulk callers

POST /callback/uploadBulkCallerSync
Description

This APIs purpose is same as Insert Bulk Caller API but it is synchronized with client. It return stats about failed/invalid and successful contacts.

Parameters
Type Name Description Schema

FormData

campaignId
optional

campaignId to upload a CSV file

string

FormData

upfile
optional

The file to upload.

file

Responses
HTTP Code Description Schema

200

If the file is successfully uploaded.

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Unacceptable, <br>-If no campaign found for specified campaignId/crmCam paignId in request. <br>-If no id specified in the request. <br>-If the uploaded file is not CSV or txt format. <br>-If no file specify in the request.

No Content

500

Internal Server Error

No Content

Consumes
  • multipart/form-data

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callback/uploadBulkCallerSync
Request formData
"file"
Example HTTP response
Response 200
[ {
  "statusString" : "File uploaded successfully"
}, {
  "Total contacts in file" : "Total contacts in file"
}, {
  "Contacts" : "Count of uploaded contacts"
}, {
  "Contacts" : "Count of failed contacts"
} ]
Response 406
[ {
  "statusString" : "campaign not found for campaignId or crmCampaignId"
}, {
  "statusString" : "if both crmCampaignId and id is null, not in parameters"
}, {
  "statusString" : "Please choose only the csv files!."
}, {
  "statusString" : "File is empty."
} ]

2.4. Call Strategies

Call Strategies – Redial Attempts

2.4.1. List call strategies

GET /callStrategy
Description

This service will be used by ECM to submit service request response back to the CRM application or the third party campaign data source. The service is supposed to be REST-based and implemented by the CRM team. ECM will be a consumer of the service.

Responses
HTTP Code Description Schema

200

List of all call strategies

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callStrategy
Example HTTP response
Response 200
[ {
  "id" : 47,
  "name" : "SMS_CS",
  "callAttempts" : [ {
    "id" : 114,
    "name" : "Att2",
    "phone" : "1",
    "channel" : 0,
    "attemptNumber" : 2,
    "retryMap" : "[{"attempt_number":0,"call_result":1},{"attempt_number":0,"call_result":2},{"attempt_number":0,"call_result":3},{"attempt_number":3,"delay":2,"call_result":4}]"
  } ]
} ]

2.4.2. Create new call strategy

POST /callStrategy/create
Description

This API will create a new caller in call strategies

Parameters
Type Name Schema

Body

Create call strategy
required

createCallStrategy

Responses
HTTP Code Description Schema

200

New Call Strategy Created Successfully

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callStrategy/create
Request body
{
  "name" : "SMS_CS",
  "attempts" : { }
}
Example HTTP response
Response 200
{
  "id" : 47,
  "name" : "SMS_CS",
  "maxAttempts" : 3,
  "callAttempts" : [ {
    "id" : 112,
    "name" : "Att1",
    "retryMap" : "[{"attempt_number":2,"delay":4}]",
    "phone" : "1",
    "channel" : 1,
    "attemptNumber" : 1
  } ]
}

2.4.3. Deletes the call Strategy

DELETE /callStrategy/delete
Description

Deletes a particular call strategy from the list

Parameters
Type Name Description Schema

Query

id
required

Id of the Strategy to be deleted

string (integer)

Query

maxAttempts
required

Id of the Strategy to be deleted

string (integer)

Query

name
required

Id of the Strategy to be deleted

string (integer)

Responses
HTTP Code Description Schema

200

Mentioned call strategy deleted successfully

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callStrategy/delete
Request query
{
  "id" : "string",
  "maxAttempts" : "string",
  "name" : "string"
}

2.4.4. Updates call strategy name

PUT /callStrategy/updateStrategy
Description

updates the name of call strategy on the basis of id and name.

Parameters
Type Name Description Schema

Body

Update Name
required

Pass id and name as input parameter

callStrategyUpdateName

Responses
HTTP Code Description Schema

200

Mentioned call strategy updated successfully

No Content

401

Unauthorized. Token authentication failed.

No Content

404

Not Found

No Content

405

Http method not allowed.

No Content

406

Not acceptable

No Content

500

Internal Server Error

No Content

Security
Type Name

apiKey

APIAuthKey

Example HTTP request
Request path
/callStrategy/updateStrategy
Request body
{
  "csId" : 7,
  "name" : "testAPI_1177",
  "attempts" : { }
}

3. Definitions

3.1. arrayResponse

Name Description Schema

ciscoCampaignId
optional

Example : "string"

string

ciscoCampaignName
optional

Example : "string"

string

class
optional

Example : "string"

string

createTime
optional

Example : "string"

string

crmCampaignId
optional

Example : "string"

string

description
optional

Example : "string"

string

enabled
optional

Example : true

boolean

endTime
optional

Example : "string"

string

fedContacts
optional

Example : "string"

string

id
optional

Example : 0

integer

name
optional

Example : "string"

string

startTIme
optional

Example : "string"

string

status
optional

Example : 0

integer

threshold
optional

Example : 0

integer

type
optional

Example : 0

integer

updateTime
optional

Example : "string"

string

weekdays
optional

Example : "string"

string

3.2. bulkCallerArrayItemOne

Here response is in KEY and VALUE pair and type of VALUE will remain same in all the responses that will be generated but KEY name can vary depends on the response returned. The KEY names can be statusString, Total contacts in file, Contacts .

Name Description Schema

KEY
optional

Example : "string"

string

3.3. bulkCallerSyncError

Type : < bulkCallerSyncObject > array

3.4. bulkCallerSyncObject

Name Description Schema

statusString
optional

Example : "string"

string

3.5. bulkCallerSyncResponse

If the file is successfully uploaded.

Type : < bulkCallerArrayItemOne > array

3.6. callStrategySuccess

Type : < callStrategySuccessObj1 > array

3.7. callStrategySuccessArr1

Type : < callStrategySuccessObj2 > array

3.8. callStrategySuccessArr2

Type : < callStrategySuccessObj3 > array

3.9. callStrategySuccessObj1

Name Description Schema

id
optional

Example : 0

integer

name
optional

Example : "string"

string

3.10. callStrategySuccessObj2

Name Description Schema

attemptNumber
optional

Example : 0

integer

channel
optional

Example : 0

integer

id
optional

Example : 0

integer

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

retryMap
optional

Example : "callStrategySuccessArr2"

callStrategySuccessArr2

3.11. callStrategySuccessObj3

Retry map Parameters can be changed depending on the situation, the parameters are attempt_number, delay, call_result

Name Description Schema

attempt_number
optional

Example : 0

integer

delay
optional

Example : 0

integer

3.12. callStrategyUpdateName

Name Description Schema

attempts
optional

Example : "createCallStrategyAttempt"

createCallStrategyAttempt

csId
required

Example : 7

integer

name
required

Example : "testAPI_1177"

string

3.13. campaignBySkillGroupErrorOne

No campaign found against particular dialer type and skill group or if crmCampaignId is not requested

Type : < campaignBySkillGroupStatus > array

3.14. campaignBySkillGroupResponse

Success response of campaign created by skill group

Type : < campaignBySkillGroupStatus > array

3.15. campaignBySkillGroupStatus

Name Description Schema

statusString
optional

Example : "Shows the status of campaign"

string

3.16. campaignIdCrmCampaignIdParams

Pause a campaign on the basis of id and crmCamapaignId

Name Description Schema

crmCampaignId
required

Example : 22

integer

id
required

Example : 3

integer

3.17. campaignKeyValueParams

pause th campaign on the basis of key value parameter

Name Description Schema

key
optional

This will be one of the field names as mentioned in Data Structure for Upload Campaign Data
Example : "businessParam3"

string

value
optional

Permissible value for the specified <Field Name>.
Example : "5"

string

3.18. campaignStatus

campaignId(integer) and status(boolean) value will be passed to change the status of the campaign

Name Description Schema

campaignId
optional

Example : 0

integer

status
optional

Example : true

boolean

3.19. createCallStrategy

Name Description Schema

attempts
optional

Example : "createCallStrategyAttempt"

createCallStrategyAttempt

name
optional

Example : "SMS_CS"

string

3.20. createCallStrategyAttempt

3.21. createCallStrategyAttemptValue

Name Description Schema

attemptNumber
optional

Example : 1

integer

channel
optional

Example : 1

integer

name
optional

Example : "aaa"

string

phone
optional

Example : "1"

string

retryMap
optional

Example : "createCallStrategyRetryMapValues"

createCallStrategyRetryMapValues

3.22. createCallStrategyResponse

Name Description Schema

callAttempts
optional

Example : "createCallStrategyResponseArray"

createCallStrategyResponseArray

id
optional

Example : 0

integer

maxAttempts
optional

Example : 0

integer

name
optional

Example : "string"

string

3.23. createCallStrategyResponseArray

3.24. createCallStrategyResponseArrayRetryMap

Here in Retry Map response parameters are in KEY and VALUE pair and type of VALUE will remain same(integer) in all responsess that will be returned but KEY name can vary depends on the required parameters and can also be more then one KEY VALUE pair. The KEY names can be attempt_number, call_result, delay.

Name Description Schema

attempt_number
optional

Example : 0

integer

3.25. createCallStrategyResponseObject

Name Description Schema

attemptNumber
optional

Example : 0

integer

channel
optional

Example : 0

integer

id
optional

Example : 0

integer

name
optional

Example : "string"

string

phone
optional

Example : "string"

string

retryMap
optional

Example : "createCallStrategyResponseObjects"

createCallStrategyResponseObjects

3.26. createCallStrategyResponseObjects

3.27. createCallStrategyRetryMapObject

Here in Retry Map request parameters are in KEY and VALUE pair and type of VALUE will remain same(integer) in all requests that will be generated but KEY name can vary depends on the required parameters and can also be more then one KEY VALUE pair. The KEY names can be attempt_number, call_result.

Name Description Schema

attempt_number
optional

Example : 0

integer

3.28. createCallStrategyRetryMapValues

3.29. createCampaign

Input parameters of /campaign/create

Name Description Schema

ciscoCampaignId
required

Example : 123

integer

ciscoCampaignName
optional

Example : "TEST_OB"

string

ciscoFileName
optional

Example : "test.txt"

string

ciscoFilePath
optional

Example : "any/path"

string

ciscoTableName
optional

Example : "5001_5002"

string

description
optional

Example : "null"

string

enabled
optional

Example : true

boolean

endTime
required

Example : "23:30"

string

name
required

Example : "Agent_Camp"

string

smsTemplate
optional

Example : ""

string

startTime
required

Example : "00:00"

string

strategyId
required

Example : 2

integer

type
required

Example : 0

integer

weekDays
optional

Example : "0,1,2,3,6"

string

3.30. createCampaignBySkillGroup

Parameters required to create a Campaign

Name Description Schema

crmCampaignId
required

Example : "1122"

string

description
optional

Example : "null"

string

dialerType
required

Example : "PREDECTIVE"

string

enabled
optional

Example : true

boolean

endTime
required

Example : "23:00"

string

name
required

Example : "Agent_Camp"

string

skillGroup
required

Example : "SkillGroupName"

string

smsTemplate
optional

Example : ""

string

startTime
required

Example : "00:00"

string

strategyId
required

Example : 2

integer

type
optional

Example : 0

integer

weekDays
optional

Example : "0,1,2,3,6"

string

3.31. editCampaignParameters

If enabled=true then we can only update the startTime and endTime. If enable=false then we can also update the strategy.

Name Description Schema

ciscoCampaignId
required

Example : 22

integer

crmCampaignId
optional

Example : "1122"

string

description
optional

Example : "null"

string

enabled
optional

Example : true

boolean

endTime
optional

Example : "23:00"

string

id
optional

Example : 2

integer

name
optional

Example : "QA_IVR"

string

smsTemplate
optional

Example : " "

string

startTime
optional

Example : "00:00"

string

strategyId
optional

Example : 2

integer

type
optional

Example : 0

integer

weekdays
optional

Example : "0,1,2,3,6"

string

3.32. fetchAllCampaigns

Success response of the Fetched campaigns

Type : < fetchCampaignsResponse > array

3.33. fetchCampaignsResponse

Success response of all fetched campaigns

Name Description Schema

campaignType
optional

Example : "string"

string

ciscCampaignId
optional

Example : "string"

string

ciscoCampaignName
optional

Example : "string"

string

ciscoFileName
optional

Example : "string"

string

ciscoFilePath
optional

Example : "string"

string

ciscoTableName
optional

Example : "string"

string

3.34. insertCaller

Will Insert a Caller

Name Description Schema

businessParam1
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam10
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam11
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam12
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam2
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam3
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam4
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam5
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam6
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam7
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam8
optional

This variable will be dependent on customer requirement.
Example : "string"

string

businessParam9
optional

This variable will be dependent on customer requirement.
Example : "string"

string

campaignId
required

This is campaign id of ECM campaign.
Example : 33

integer

crmCampaignId
required

If some customer have associated an ECM campaign with CRM campaign during creation of campaign at ECM,then it can send crm campaign id in this field and leave the above campaignId field.
Example : 2

integer

dialTime
optional

This is to set the dial time if the contact is to be dialed on a specified time.
Example : "string"

string

phone1
required

This is the primary phone number of the contact. Note that a number can be comprised of 15 digits in total and should not be lesser than 3 digits. International numbers with a ‘+’along with the country prefix is also supported.
Example : "03226598781"

string

phone2
optional

Contact second number, there are total of five number. Not that a number can be comprised of 15 digits in total and should not be lesser than 3 digits.International numbers with a ‘+’ along with the country prefix is also supported.
Example : "string"

string

phone3
optional

Third Number
Example : "string"

string

phone4
optional

Fourth Number
Example : "string"

string

phone5
optional

Fifth Number
Example : "string"

string

3.35. insertCallerStatus

Name Description Schema

enumType
optional

Example : "string"

string

name
optional

Example : "string"

string

3.36. insertCallerSuccessResponse

Success Response of caller Insertion

Name Description Schema

status
optional

Example : "insertCallerStatus"

insertCallerStatus

statusString
optional

Example : "string"

string

3.37. showCampaignSuccessResponse

Success Response of showing all campaigns

Type : < arrayResponse > array

3.38. uploadBulkCallersObject

Name Description Schema

statusString
optional

Example : "string"

string

3.39. uploadBulkCallersResponse

Type : < uploadBulkCallersObject > array

3.40. userLogin

Input parameters of /api/login

Name Description Schema

password
required

Example : "string"

string (string)

username
required

Example : "string"

string (string)

3.41. userLoginSuccessfully

output response of /api/login for 200

Name Description Schema

email
optional

Example : 0

integer

id
optional

Example : "string"

string

token
optional

Example : "string"

string

username
optional

Example : "string"

string

4. Security

4.1. APIAuthKey

Type : apiKey
Name : X-AUTH-TOKEN
In : HEADER