API Reference

Create campaign

post
https://{defaultHost}/api/v4/campaigns

Creates a new outbound dialer campaign.

Body Params
string
required
length ≤ 100

The name of the campaign. Must be unique within the contact center.

string
enum
Defaults to simple

Dialing strategy for the campaign. predictive_ai is only available if Dialer AI is enabled for the contact center.

Allowed:
float
1 to 6
Defaults to 1

Number of simultaneous call attempts per available agent.

dial_level_override
object

Dial level override configuration.

integer
1 to 600
Defaults to 60

Maximum time in seconds to spend dialing a contact before hanging up.

integer
0 to 3600
Defaults to 5

Maximum time in seconds to wait for an available agent when a contact answers.

integer
1 to 99
Defaults to 3

Maximum number of attempts to dial a contact.

integer | null

Identifier of the voice message to play. Must reference an existing voice message in the contact center.

boolean
Defaults to true

Whether answering machine detection is enabled for calls.

live
object | null

Configuration for adding leads to the campaign while it is running.

caller_id_sets
array of objects
required
length between 1 and 20

Sets of caller IDs used for outbound calls. Maximum 20 sets.

caller_id_sets*
phone_numbers
array of strings
required

Phone numbers in the caller ID set.

phone_numbers*
boolean
Defaults to false

Whether to use only caller IDs matching the contact's country or region.

boolean
Defaults to true

Whether ASR (Answer Seizure Ratio) optimization is enabled.

post_call_rating
object | null

Post-call survey configuration.

contact_local_time
object | null

Time restrictions for calling contacts based on their local time. Only available if the contact local time feature is enabled for the contact center. Set to null to clear.

follow_up_rules
object | null

Rules for redialing contacts based on call disposition. Each disposition can have up to 20 rules.

Responses

Updated 22 days ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago