Campaigns List

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

campaigns:read

Body Response - Schema

200 (successful operation)

ParameterTypeDescriptionRequired
totalintegern/ayes
countintegern/ayes
pageintegern/ayes
per_pageintegern/ayes
total_pageintegern/ayes
_embeddedobject"_embedded" subdivides into:

1 - "campaings" (array[object]
)
, the list of campaigns, which subdivides into:

1.1 - "_links" (object) - HAL API related links.
1.1.1 - "self" (object) - link to fetch the detail of the campaign.
1.1.1.1 - "href" (string) - address of the resource. <= 2083 characters.
1.1.2 - "campaigns" (object) - link to fetch a list of all the campaigns.
1.1.2.1 - "href" (string) - address of the resource. <= 2083 characters.

1.2 - "id" (string
)
- <= 36 characters.

1.3 - "name" (string) - >= 3 characters;
<= 35 characters.

1.4 - "dialing_mode" (string) - <= 35 characters. Allowed values: "PREDICTIVE",
"PREVIEW".

1.5 - "priority" (integer) - >= 1; <= 10

1.6 - "run_once" (boolean)

1.7 - "action_required" (boolean)

1.8 - "status" (string) - <= 35 characters. Allowed values:
"INCOMPLETE", "READY",
"RUNNING", "PAUSED"

1.9 - "created_at" (string) - <= 35 characters. Allowed values:
"INCOMPLETE", "READY",
"RUNNING", "PAUSED"
yes
_linksobjectHAL API related links. "_links" subdivides into:

1 - "self" (object) - link to fetch the detail of the campaign.
1.1 - "href" (string) - address of the resource. <= 2083 characters.

2 - "prev" (object)
2.1 - "href" (string) - <= 2083 characters.

3 - "next" (object)
3.1 - "href" (string) -<= 2083 characters.

4 - "first" (object)
4.1 - "href" (string) -<= 2083 characters.

5 - "last" (object)
5.1 - "href" (string) -<= 2083 characters.
yes

400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

❗️

API Availability

The Campaign Management API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.

The Campaign Management APII has been in EA since November 2022.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!