Versions Compared

Key

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

...

2namestringCampaign's name
3descriptionstringCustom campaign description
4typestring

Dialer type. It can take one of the values:

  • Predictive Dialer
  • Progressive Dialer
  • Voice Broadcasting
5prioritynumberCampaign priority (any integer). Default number is 0.
6calendarobjectWork calendar. You must specify the identifier and name of the previously created calendar.
10parametersobjectAdditional campaign parameters: 11 - 25.
11limitnumberThe maximum number of simultaneous calls.
12minBillSecnumberThe minimum duration of a successful call is "in conversation" if the call result function is not enabled (20).
13originateTimeoutnumberThe maximum duration of a subscriber call.
14maxTryCountnumberThe maximum number of attempts to dial a subscriber.
15intervalTryCountnumberWaiting between dialing attempts in seconds.
16wrapUpTimenumberDuration of waiting for a call result if the call result function is enabled (20).
17predictAdjustnumberThe number of completed attempts, after which the Predictive mechanisms for the Predictive Dialer are turned on.
18targetPredictiveSilentCallsnumberTarget lost call rate for the Predictive Dialer.
19maxPredictiveSilentCallsnumberThe maximum allowable rate of lost calls for the Predictive Dialer.
20waitingForResultStatusbooleanCall Result - the expected result of dialing a subscriber from an external system through the REST API.
21recordSessionbooleanEnable conversation recording.
22eternalQueueboolean"Eternal Campaign" - do not stop after all subscribers have dialed.
23retryAbandonedbooleanContinue attempts to dial the subscriber after he has been "lost".
24retriesByNumberbooleanThe number of attempts for the type of number to count for each number of this type separately.
25oneDayTaskbooleanOne day campaign. Do not transfer subscribers to the next day if all attempts are made to dial within one day (0:00 - 24:00).
27amdobjectFunction of answering machine detection: 28 - 38.
28enabledbooleanEnable autoresponder detection.
29allowNotSurebooleanTransfer calls to the operator in which unambiguous recognition of the person is not received.
30maximumWordLengthnumberMaximum duration of one sentence (ms).
31maximumNumberOfWordsnumberThe maximum number of words in the greeting. If it is exceeded - an answering machine.
32betweenWordsSilencenumberDuration of silence between words (ms).
33minWordLengthnumberThe minimum duration of a continuous voice sound to define this sound as a word (ms).
34totalAnalysisTimenumberThe maximum time set for the operation of the algorithm for identifying a person or answering machine (ms).
35silenceThresholdnumberThe maximum duration of silence between words (ms).
36afterGreetingSilencenumberSilence after greeting (ms).
37greetingnumberMaximum greeting length (ms).
38initialSilencenumber

Maximum silence before greeting (ms).

40variablesobjectAdditional variables that will be assigned to the channel of each dial-up attempt for all campaign subscribers.
43numberStrategystring

Number selection strategy by type of subscriber communication facility. One of the values is possible:

  • by-priority - we make a given number of attempts, first, according to the highest priority type of communication tool, then move on to the next type.
  • top-down - one attempt is sequentially performed for each type of communication medium.
44membersStrategystring

The strategy of passing the list of subscribers. One of the values is possible:

  • next-tries-circuit - at the beginning, select subscribers who have a higher priority and were previously added taking into account the time of the next dial-up attempt.
  • strict-circuit - at the beginning, select subscribers who have a higher priority and were previously added. The time of the next dial-up attempt should be taken into account only after the complete passage of the entire list of subscribers.
45autoResetStatsbooleanAutomatically clear statistics and performance indicators of campaign operators at 0:00.
46resourcesarrayAn array of objects with outbound callflow (47 - 62).
48dialedNumberstringRegular expression of the subscriber's phone number.
49destinationsarrayArray of objects (50 - 59), with a description of the directions of the output of the call.
51gwNamestringGateway name from 07 Gateways.
52dialStringstringDial number string.
54ordernumberOrder (sequence) of choice.
55limitnumberThe number of simultaneous calls in this direction.
56enabledbooleanenabled or not
57callerIdNumberstringCallerID для направленияfor destination.
62agentParamsobjectGeneral parameters of operators in the campaign (63 - 68). If not set, then the individual settings of each of the operators in the 06 Directory are taken into account.
63callTimeoutnumberThe maximum duration of a call to the operator (dial-up to the operator).
64wrapUpTimenumberThe time for completing the call. At this time, the dialer does not distribute the call to the agent.
65maxNoAnswernumberThe maximum number of consecutive calls without an operator answering, after which the system will take the operator to a break.
66busyDelayTimenumberThe delay in seconds between calls from the queue if the agent is busy.
67rejectDelayTimenumberThe delay in seconds between calls from the queue if the agent rejects the call.
68noAnswerDelayTimenumberThe delay in seconds between calls from the queue if the agent did not answer.
70agentsarrayAn array with the numbers of operators assigned to this campaign.
74skillsarrayAn array with operator skills that will be automatically included in this campaign.
77agentStrategystring

The strategy of choosing a free operator. One of the values is possible:

  • random - in random order.

  • agent-with-fewest-calls - first to the operator with the least number of calls.

  • agent-with-least-talk-time- first to the operator with the least time in the conversation.

  • longest-idle-agent- first to the operator with the longest waiting time.

78communicationsobjectCommunication facilities of subscribers.
79typesarrayAn array with types of communication tools of subscribers (80 - 104).
81namestringThe name of the type of communications.
82codestringCommunication type code.
83rangesarrayAn array of objects describing time and quantity parameters for each type of communication tool.
85startTimenumberThe start time of the action.
86endTimenumberAction completion time.
87attemptsnumberThe number of attempts to dial.
88prioritynumberPriority.

...