Chat Campaign

Create Chat Campaign

Create a new chat campaign with the provided details.

post/APIServices/campaignControl/chat

Request

Base URL
https://in1-ccaas-api.ozonetel.com
URL
https://in1-ccaas-api.ozonetel.com/APIServices/campaignControl/chat
Auth
none declared. Required headers: Content-Type

Headers

Content-Typestring required

Request body

usernamestring

Account username

apiKeystring

API key for authentication

actionstring

Operation to perform

campaignNamestring

Name of the new chat campaign

campaignTypestring

Campaign type (Chat)

usersstring

Comma-separated list of users for the campaign

identifierstring

Primary chat identifier

dynamicIdentifierstring

Dynamic identifier

concurrentChatsstring

Maximum concurrent chats allowed

ivrFlowstring

IVR flow name

urlToPushstring

Webhook or push URL for campaign events

hitScreenpopURLAtstring

Where to hit the screen pop URL (e.g., Plugin)

screenPopUrlstring

Screen pop URL

pluginNamestring

Plugin name used

dispositionsstring

Comma-separated list of disposition values

dispositionTypestring

Type of disposition interface

wrapUpTimestring

Wrap-up time after chat ends (in seconds)

blockNumberstring

Blocking number list or value

blockNumberGroupsstring

Comma-separated block number groups

dailyObdLimitPerNumberstring

Daily outbound limit per number

skillsstring

Comma-separated skill names for routing

useTransferSkillsboolean

Whether transfer skills should be used

transferSkillsstring

Comma-separated transfer skills

Example request

{
  "username": "xxxxx",
  "apiKey": "KKxxxxxxxxxxxxxxxxxxxx",
  "action": "create",
  "campaignName": "xxxx",
  "campaignType": "Chat",
  "users": "xxxxx",
  "identifier": "xxxx",
  "dynamicIdentifier": "xxxx",
  "concurrentChats": "1",
  "ivrFlow": "xxxx",
  "urlToPush": "campaignControl.com",
  "hitScreenpopURLAt": "Plugin",
  "screenPopUrl": "campaignControlPop.com",
  "pluginName": "Azure",
  "dispositions": "Not Interested,No Response,Interested,Interested in other product",
  "dispositionType": "Toolbar",
  "wrapUpTime": "30",
  "blockNumber": "None",
  "blockNumberGroups": "BlockNumbers,BlockNumbers1",
  "dailyObdLimitPerNumber": "15",
  "skills": "Test_Skill,ChatOnCall",
  "useTransferSkills": true,
  "transferSkills": "Test_Skill,ChatOnCall"
}

Response

Campaign created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.