get https://api.talkdeskapp.com/do-not-call-lists//entries
Scope
do-not-call-lists:manage
Body Response - Schema
200 (get a list of entries)
List with the paginated samples
| Parameter | Type | Description | Required |
|---|---|---|---|
| per_page | integer | the number of items per page | yes |
| total | integer | the total number of items | no |
| count | integer | the number of items in the page | no |
| page | integer | the number of the current page | no |
| total_pages | integer | the total number of pages | no |
| _links | object | HAL API related links "_links" subdivides into: "href" (string) - address of the resource | no |
| _embedded | object | "_embedded" subdivides into: 1 - "entries (array[object]) - list of entries paginated. Subdivides into: 1.1 - "id" (string) - entry ID. 1.2 - "do_not_call_list_id" (string) - do not call list ID 1.3 - "phone_number" (string) - phone number of the record 1.4 - "reason" (string) - reason for the phone number is being added to do not call list 1.5 - "expiration_date" (string) - date where the DNCL entry expires 1.6 - "expiration_date" (string) - date where the dncl entry expires 1.7 - "created_at" (string) - record creation date 1.8 - "_links" (object) - record creation date 1.8.1 - "self" (object) 1.8.1.1 - "href" (string) | no |
401 (unauthorized), 403 (forbidden), 404 (do not call list 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) |
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.