Filtered List of Entries

Returns a list of entries from a DNCL object filtering by phone numbers and timezones

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

do-not-call-list:manage

Body Request - Example

{
  "phone_numbers": [
    {
      "phone_number": "+351987890987",
      "timezone": "Europe/Lisbon"
    },
    {
      "phone_number": "+351911890987",
      "timezone": "Europe/Lisbon"
    }
  ]
}

Body Response - Schema

200 OK (returns the list of entries filtered by phone numbers and timezone)

List with the paginated samples

ParameterTypeDescriptionRequired
per_pageintegerthe number of items per pageno
totalintegerthe total number of itemsno
countintegerthe number of items in the pageno
pageintegerthe number of the current pageno
total_pagesintegerthe total number of pagesno
_linksobjectHAL API related links.
"_links" subdivides into:

1 - "next" (object) - link of the next page. Required.
1.1 - "href" (string) - address of the resource.

2 - "last" (object) - link of the last page. Required.
2.1 - "href" (string) - address of the resource.

3 - "prev" (object) - link of the previous page. Required.
3.1 - "href" (string) - address of the resource.

4 - "firstlf" (object) - link of the first page. Required.
4.1 -
"href" (string)** - address of the resource.
no
_embeddedobject"_embedded" subdivides into:

1 - "entries" (array "Parame) - list of entries paginated.

1.1 - "id" (string) - entry ID.

1.2 - "do_not_call_list_id" (string) - DNCL ID (optional).

1.3 - "phone_number" (string) - phone number of the record.

1.4 - "reason" (string) - reason for the phone number being added to do not call list.

1.5 - "expiration_date" (string) - date where the DNCL entry expires.

1.6 - "created_at" (string) - record creation date.

1.7 - "_links" (object)
1.7.1 - "self" (object)
1.7.2 - "href" (string)
no

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

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarrayk:parame"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.

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