To a campaign
Scope
campaigns:read
Body Response - Schema
200 (assigned numbers returned successfully)
| Parameter | Type | Description | Required |
|---|---|---|---|
| total | integer |
| yes |
| count | integer |
| yes |
| page | integer |
| yes |
| per_page | integer |
| yes |
| total_pages | integer |
| yes |
| _embedded | object | "_embedded" subdivides into: 1 - "numbers" (array[object]) - the list of numbers. Required. 1.1 - "_links" (object) - HAL API related links. 1.1.1 - "self" (object) - link to fetch the detail of the campaign.
1.1.2 - "numbers" (object) - link to fetch a list of all the campaigns.
1.2 - "id" (string) - the uuid of the number. Required. 1.3 - "phone_number" (string) - the phone number in E.164 format. | |
| _links | object | HAL API related links. "_links" subdivides into: 1 - "self" (object) - link to fetch a list of all numbers. 2 - "prev" (object) 3 - "next" (object) 4 - "first" (object) - 5 - "last" (object) - | yes |
400 (errors found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (campaign not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API AvailabilityThe 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.
TroubleshootingIf 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.