post https://{domainname}/APIServices/campaignControl/inbound
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. Provide the audio URL as the parameter value in either .mp3 or .wav format. Note that this parameter is optional. |
| 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 true activates 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 | "{ ""Message"": ""Invalid apiKey"" }" |
| Passing Invalid apiKey Value | "{ ""Message"": ""Authentication failed."" }" |
| Passing Invalid userName Key / Missing userName key / Missing userName Value | "{ ""Message"": ""Invalid username"" }" |
| Passing Invalid userName Value | "{ ""Message"": ""Authentication failed."" }" |
| Providing Empty / Null Campaign Name | "{ ""Message"": ""Campaign Name is required"" }" |
| 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 | "{ ""Message"": ""Campaign Name is required"" }" |
| Providing invalid Campaign Type / Providing Empty Campaign Type / Not Providing Campaign Type Parameter | "{ ""Message"": ""Invalid Campaign Type"" }" |
| Providing Invalid DID | "{ ""Message"": ""Please enter the Valid DID assigned to the account."" }" |
| Providing acceptable values to DID parameter | {"Message": "Campaign XXXXX Created Successfully."} |
| Providing Empty DID | "{ ""Message"": ""DID must be between 3 and 16 digits and allows the + prefix"" }" |
| Not Providing DID Parameter | "{ ""Message"": ""DID must be between 3 and 16 digits and allows the + prefix"" }" |
| Providing Invalid Fallback DID | "{ ""Message"": ""Please enter the Valid FallbackDID assigned to the account"" }" |
| Providing acceptable values to Fallback DID parameter | {"Message": "Campaign XXXXX Created Successfully."} |
| Providing Empty Fallback DID | "{ ""Message"": ""FallBack DID must be between 3 and 16 digits and allows the + prefix"" }" |
| Providing Fallback DID when ROLE_Fallback_DID is not assigned to the account. | "{ ""Message"": ""FallBack DID role is not assigned to this account. Please contact the admin."" }" |
| Providing Valid "URL To Push" / Providing InValid "URL To Push" / Providing Empty OR Null "URL To Push" / Not providing "URL To Push" Parameter | "{ ""Message"": ""Campaign XXXXXX Created Successfully."" }" |
| Providing invalid "ScreenPop URL" / Providing Empty OR Null "ScreenPop URL" | "{ ""Message"": ""Invalid hitScreenPopUrlAT"" }" |
| Providing "ScreenPop URL" when no ""Hit ScreenPop URl At" is provided | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing valid "Hit ScreenPop URl At" as Plugin and without passing Plugin Name | "{ ""Message"": ""Invalid pluginName"" }" |
| Providing valid "Hit ScreenPop URl At" as Plugin and passing Valid Plugin Name which are in account. | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Not providing "ScreenPop URL" when ""Hit ScreenPop URl At" is provided | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing valid "ScreenPop URL" | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing invalid "ScreenPop URL" | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing Empty/ Null "ScreenPop URL" | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing "ScreenPop URL" when no ""Hit ScreenPop URl At" is provided | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing Invalid Prefix | "{ ""Message"": ""Call Prefix should be between 1 to 6 digits long and allows prefix +"" }" |
| Providing Empty/ Null Prefix | "{ ""Message"": ""Call Prefix should be between 1 to 6 digits long and allows prefix +"" }" |
| Not providing Prefix Parameter | "{ ""Message"": ""Campaign InboundAPICamp666 Created Successfully."" }" |
| When Role_Prefix is assigned to the accunt and passing prefix key and value. | "{ ""Message"": ""Call Prefix role is not assigned to this account. Please contact the admin."" }" |
| When Role_Prefix is not assigned to the account and not passing prefix key and value | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing Invalid Block Number / Providing Empty Block Number / Not Providing Block Number Parameter | "{ ""Message"": ""Invalid BlockNumber"" }" |
| Providing valid Block Number as "Block" and passing Invalid Blocknumber Group. | "{ ""Message"": ""Please Pass valid Block Group"" }" |
| Providing valid Block Number as "Allow" and passing Invalid Blocknumber Group. | "{ ""Message"": ""Please Pass valid Block Group"" }" |
| Providing valid Block Number as "Allow" and not passing Blocknumber Group. | "{ ""Message"": ""Please Pass valid Block Group"" }" |
| Providing valid Record option | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Providing Invalid Record / Providing Empty Record | "{ ""Message"": ""Invalid recOn"" }" |
| Passing Record value without enabling "Allow Manual Dialing". | "{ ""Message"": ""Campaign XXXX Created Successfully."" }" |
| Not Providing Record Parameter | "{ ""Message"": ""Invalid recOn"" }" |
| Providing invalid Dispostion Type / Providing Empty Dispostion Type / Not Providing Dispostion Type Parameter | "{ ""Message"": ""Disposition Type Invalid"" }" |
| Providing invalid Disposition / Providing Empty Disposition / Not Providing Disposition Parameter | "{ ""Message"": ""Please pass valid disposition"" }" |
| Providing Invalid WrapUp Time | "{ ""Message"": ""wrapUpTime should be between 0 to 9999 seconds."" }" |
| Providing Empty WrapUp Time / Not Providing WrapUp Time Parameter | "{ ""Message"": ""wrapUpTime should be between 0 to 9999 seconds."" }" |
| Providing invalid User Assigned / Providing Empty User Assigned | "{ ""Message"": ""Invalid users."" }" |
| Not Providing User Assigned Parameter | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing valid User Assigned | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing invalid User Assigned / Providing Empty User Assigned | "{ ""Message"": ""Invalid users."" }" |
| Not Providing User Assigned Parameter | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing Invalid Music File - On Hold | "{ ""Message"": ""holdMusic is invalid"" }" |
| Not Providing Music File - On Hold | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing Invalid Music File - On Transfer / | "{ ""Message"": ""transferMusic is invalid"" }" |
| Creating campaign when ROLE_DND_Check is not assigned to the account. | "{ ""Message"": ""DND Enable role is not assigned to this account. Please contact the admin."" }" |
| DND Check=True when ROLE_DND_Check is not assigned | "{ ""Message"": ""DND Enable role is not assigned to this account. Please contact the admin."" }" |
| DND Check=False when ROLE_DND_Check is not assigned | "{ ""Message"": ""DND Enable role is not assigned to this account. Please contact the admin."" }" |
| Providing True to all the check boxes | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing False to all the check boxes | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Create Duplicate campaign | "{ ""Message"": ""Campaign name Already Exists."" }" |
| Providing InValid IVR Flow | "{ ""Message"": ""Please pass valid IVR flow."" }" |
| Providing Empty/Null IVR Flow | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Providing Empty/Null IVR Flow | "{ ""Message"": ""Campaign XXXXX Created Successfully."" }" |
| Updating play disclaimer when campaign is in Running State. | "{ ""Message"": ""Please change the campaign status to Ready or Completed to update the campaign."" }" |