Use this API to create an inbound campaign within your CloudAgent account.
In the BODY PARAMS provide the parameters that apply to create your campaign.
For domestic (Indian) ccaas - enter the domain: api.cloudagent.ozonetel.com
For International ccaas - enter the domain: ccaas.ozonetel.com
Note:
Please consider the following points while using these campaign handling APIs.
- You cannot use Null or empty values for non-mandatory parameters. If those parameters are not required, do not add them to the BODY PARAMS.
- "position" parameter is not applicable in the Payload.
- When Fallback is not given in the payload (BODY PARAMS), campaign will be created with Fallback as None.
- We cannot update campaigns in Running Position.
- File to Upload is mandatory for ccaas customers, but we will be able to create campaigns with API without Data File.
- Mapping File Creation is not handled.
- As of now, Advanced Retry Page is not Handled with the APIs.
- You cannot update Campaign Name, as update is done based on Campaign Name as Primary value.
- Actions like Start, Stop, Reset, Force Stop and Delete data are not handled.
- Rate Limit to create a campaign: 2 request per minute per user, irrespective of the campaign type (Inbound Or Outbound).
Parameter (newKey) | Description (New value) |
|---|---|
username* | Provide the CloudAgnet account name |
campaignName* | Give a name for the campaign to be created |
apiKey* | Provide the API key of your account. Available in CloudAgent after admin login |
action* | To create a campaign - "create" |
campaignType* | "InBound" |
users | Add the list of users with comma-separated values. Example: user1,user2 |
did* | Provide a DID for the campaign |
fallbackDID | Add the fallback DID |
ivrFlow | Name of the IVR flow to be associated with the campaign. |
callbackUrl | Add the callback URL |
popUrlAt | Specify if it is at the "Client Side" / "Server Side" / "Client&Server" / "Client Side OnBusy" / "Plugin" / "Server Side OnBusy" |
callPrefix | Add the call prefix as required. Example: "+" |
dispositions* | Provide the list of dispositions with comma-separated values. |
dispositionType* | Specify the disposition type, whether through the API or toolbar or if no disposition is needed. "API" / "Toolbar" / "None" |
wrapUpTime* | Give the wrap-up time in seconds. Example: 30 |
blockNumber | "Block" / "Allow" / "None" |
blockNumberGroups* | Provide the block number group name |
playDisclaimerURL | This parameter is functional only if "Allow Manual Dialing" is enabled for inbound campaigns. For outbound campaigns, there are no such restrictions. |
record* | "Record the call in Full" / "Record only the conversation" / "Do not record calls" |
obdLimitperNumber | This is the "Daily Outbound Limit per Number" from the account. Add the numerical value |
holdMusic | Audio_New |
transferMusic | Music_new |
screenPopUrl | Give the screen pop URL |
dndEnable | Setting dndEnable to trueactivates the Do Not Disturb feature. When this checkbox is checked, the system will reference the Do Not Disturb log and prevent calls from being dialed. |
offLineMode | "false" - providing the parameter value as "false" disables the setting. |
acwNac | "false" - providing false as a parameter disables the setting |
allowedManual | "false" - providing false as a parameter disables the setting |
dncEnabled | "false" - providing false as a parameter disables the setting |
didMasking | "false" - providing false as a parameter disables the setting |
a2aCalling | "false" - providing false as a parameter disables the setting. This is an agent-to-agent (internal calling) dialing feature. To know more about the Internal calling feature refer to, Agent to Agent Calling. |
skills* | Provide the list of skill names with comma-separated values. |
position | "READY"/ "RUNNING" / "COMPLETED" |
script | Add the script for the campaign as you need. |
Possible Responses
Success Response | {"Message": "Campaign XXXXX Created Successfully."} |
Passing Invalid apiKey Key / Missing apiKey key / Missing apiKey Value | "{ |
Passing Invalid apiKey Value | "{ |
Passing Invalid userName Key / Missing userName key / Missing userName Value | "{ |
Passing Invalid userName Value | "{ |
Providing Empty / Null Campaign Name | "{ |
Providing Invalid Campaign Name | {"Message": "Campaign Name should be between 2 to 255 alphanumeric characters long and allows special characters like .,@,_,-"} |
Providing acceptable values to the Campaign Name parameter | {"Message": "Campaign XXXXX Created Successfully."} |
Not Providing Campaign Name Parameter | "{ |
Providing invalid Campaign Type / Providing Empty Campaign Type / Not Providing Campaign Type Parameter | "{ |
Providing Invalid DID | "{ |
Providing acceptable values to DID parameter | {"Message": "Campaign XXXXX Created Successfully."} |
Providing Empty DID | "{ |
Not Providing DID Parameter | "{ |
Providing Invalid Fallback DID | "{ |
Providing acceptable values to Fallback DID parameter | {"Message": "Campaign XXXXX Created Successfully."} |
Providing Empty Fallback DID | "{ |
Providing Fallback DID when ROLE_Fallback_DID is not assigned to the account. | "{ |
Providing Valid "URL To Push" / Providing InValid "URL To Push" / Providing Empty OR Null "URL To Push" / Not providing "URL To Push" Parameter | "{ |
Providing invalid "ScreenPop URL" / Providing Empty OR Null "ScreenPop URL" | "{ |
Providing "ScreenPop URL" when no ""Hit ScreenPop URl At" is provided | "{ |
Providing valid "Hit ScreenPop URl At" as Plugin and without passing Plugin Name | "{ |
Providing valid "Hit ScreenPop URl At" as Plugin and passing Valid Plugin Name which are in account. | "{ |
Not providing "ScreenPop URL" when ""Hit ScreenPop URl At" is provided | "{ |
Providing valid "ScreenPop URL" | "{ |
Providing invalid "ScreenPop URL" | "{ |
Providing Empty/ Null "ScreenPop URL" | "{ |
Providing "ScreenPop URL" when no ""Hit ScreenPop URl At" is provided | "{ |
Providing Invalid Prefix | "{ |
Providing Empty/ Null Prefix | "{ |
Not providing Prefix Parameter | "{ |
When Role_Prefix is assigned to the accunt and passing prefix key and value. | "{ |
When Role_Prefix is not assigned to the account and not passing prefix key and value | "{ |
Providing Invalid Block Number / Providing Empty Block Number / Not Providing Block Number Parameter | "{ |
Providing valid Block Number as "Block" and passing Invalid Blocknumber Group. | "{ |
Providing valid Block Number as "Allow" and passing Invalid Blocknumber Group. | "{ |
Providing valid Block Number as "Allow" and not passing Blocknumber Group. | "{ |
Providing valid Record option | "{ |
Providing Invalid Record / Providing Empty Record | "{ |
Passing Record value without enabling "Allow Manual Dialing". | "{ |
Not Providing Record Parameter | "{ |
Providing invalid Dispostion Type / Providing Empty Dispostion Type / Not Providing Dispostion Type Parameter | "{ |
Providing invalid Disposition / Providing Empty Disposition / Not Providing Disposition Parameter | "{ |
Providing Invalid WrapUp Time | "{ |
Providing Empty WrapUp Time / Not Providing WrapUp Time Parameter | "{ |
Providing invalid User Assigned / Providing Empty User Assigned | "{ |
Not Providing User Assigned Parameter | "{ |
Providing valid User Assigned | "{ |
Providing invalid User Assigned / Providing Empty User Assigned | "{ |
Not Providing User Assigned Parameter | "{ |
Providing Invalid Music File - On Hold | "{ |
Not Providing Music File - On Hold | "{ |
Providing Invalid Music File - On Transfer / | "{ |
Creating campaign when ROLE_DND_Check is not assigned to the account. | "{ |
DND Check=True when ROLE_DND_Check is not assigned | "{ |
DND Check=False when ROLE_DND_Check is not assigned | "{ |
Providing True to all the check boxes | "{ |
Providing False to all the check boxes | "{ |
Create Duplicate campaign | "{ |
Providing InValid IVR Flow | "{ |
Providing Empty/Null IVR Flow | "{ |
Providing Empty/Null IVR Flow | "{ |
Updating play disclaimer when campaign is in Running State. | "{ |