Skip to main content

PowerDialerCampaignPatchRequest

Provide lockVersion and at least one field to change.

namestring

Possible values: non-empty and <= 160 characters

descriptionstring

Possible values: <= 2000 characters

priorityinteger

Possible values: >= 1 and <= 100

concurrencyCapinteger

Maximum simultaneous calls (the live speed control).

Possible values: >= 1 and <= 10000

targetAttemptsPerMinuteinteger

Possible values: >= 1 and <= 100000

configuration object

Immutable, typed campaign configuration revision used by scheduler and dispatcher.

schemaVersionintegerrequired
Constant value: 1
basics objectrequired
property name*any
audience objectrequired
property name*any
agentAndCallerId objectrequired
property name*any
schedule objectrequired
property name*any
dialing objectrequired
dialPrefixPolicy object
modestringrequired

Possible values: [inherit_trunk, campaign]

Default value: inherit_trunk
defaultPrefixstringrequired

Possible values: <= 32 characters, Value must match regular expression ^[0-9*#]*$

Default value:
stripLeadingPlusbooleanrequired
Default value: true
rules object[]required

Possible values: <= 50

  • Array [
  • namestringrequired

    Possible values: non-empty and <= 80 characters

    matchTypestringrequired

    Match the first X normalized destination digits, or a three-digit North American Numbering Plan area code.

    Possible values: [starts_with, nanp_area_code]

    matchValuestringrequired

    Possible values: Value must match regular expression ^[0-9]{1,15}$

    dialPrefixstringrequired

    Possible values: <= 32 characters, Value must match regular expression ^[0-9*#]*$

    priorityintegerrequired

    Possible values: >= 1 and <= 10000

    enabledbooleanrequired
  • ]
  • property name*any
    dispositions objectrequired
    property name*any
    applyPolicystring

    Possible values: [next_attempt, next_schedule_window, drain_then_resume]

    lockVersionintegerrequired

    Current campaign lockVersion for optimistic concurrency.

    Possible values: >= 0

    PowerDialerCampaignPatchRequest
    {
    "name": "string",
    "description": "string",
    "priority": 0,
    "concurrencyCap": 0,
    "targetAttemptsPerMinute": 0,
    "configuration": {
    "schemaVersion": 1,
    "basics": {},
    "audience": {},
    "agentAndCallerId": {},
    "schedule": {},
    "dialing": {
    "dialPrefixPolicy": {
    "mode": "inherit_trunk",
    "defaultPrefix": "",
    "stripLeadingPlus": true,
    "rules": [
    {
    "name": "string",
    "matchType": "starts_with",
    "matchValue": "string",
    "dialPrefix": "string",
    "priority": 0,
    "enabled": true
    }
    ]
    }
    },
    "dispositions": {}
    },
    "applyPolicy": "next_attempt",
    "lockVersion": 0
    }