Skip to main content

List blocked numbers

GET 
/api/v1/blocked-numbers/list

Retrieve the numbers on one of your account's two lists of numbers that are skipped when you send to groups: blocked or ignored. See Add blocked numbers for the difference between the lists.

Only one list is returned per request; choose it with type. Numbers are returned newest first, up to 200 per page. Use page and morePages to get the rest, and search to find a specific number.

Request​

Query Parameters

    page integer

    Possible values: >= 1

    The page number of results you want to retrieve. Each page holds up to 200 numbers. A value that is not a number, or lower than 1, returns the first page.

    Default value: 1
    type string

    Possible values: [blocked, ignored]

    Which list to retrieve: blocked or ignored.

    Default value: blocked
    search string

    Return only numbers that contain this text. Local (0700000001) and international (46700000001) formats both match.

Responses​

The list was successfully retrieved. blockedNumbers is an empty array when there is nothing on the page.