get https://api.talkdeskapp.com/do-not-call-lists/
Scope
do-not-call-lists:manage
Body Response - Schema
200 (the do not call list details)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | ID of the do not call list created | no |
| name | string | do not call list name | no |
| created_at | string | do not call list creation date | no |
| updated_at | string | do not call list updated date | no |
| status | string | Status of validation process done on the do not call list csv file. Allowed values: "REJECTED", "VALIDATION_STARTED", "UPLOADED", "ACCEPTED", "INCOMPLETE, "CORRUPTED" | no |
| entries_count | integer | how many entries are present in the do not call list | no |
| teams | array[object] | Teams that this do not call list belongs to, if any. "teams" subdivides into: 1 - "id" (string) - the team ID of the do not call list. 2 - "name" (string) - the team name of the do not call list. 3 - "_links" (object) - the team name of the do not call list. 3.1 - "self" (object) 3.1.1 - "href" (string) | no |
| account_id | string | account ID of do not call list | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) 1.1 - "href" (string) | no |
401 (unauthorized), 403 (forbidden), 404 (do not call list not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| codes | 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) |
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.