Search for Sudonum

Request

This endpoint allows the user to search for phone numbers based on specific criteria. The request should be sent as an HTTP POST to {{baseUrl}}/v2/number/search/.

Request Body

country_code_iso (string): The ISO country code for the country in which the numbers are to be searched.

country_code (number): The country code for the country in which the numbers are to be searched.

capabilities (string): The capabilities of the numbers to be searched. Note that this only works for RSA numbers. (Optional)

starts_with (string): The starting digits of the numbers to be searched, excluding the country code. (Optional)

ends_with (string): The ending digits of the numbers to be searched. (Optional)

contains (string): The digits that the numbers to be searched must contain. (Optional)

prefix_type (string): The type of prefix for the numbers to be searched, which can be one of: LOCAL, MOBILE, NATIONAL, TOLL_FREE. (Optional)

NOTE: Either country_code_iso or country_code are required fields.

Response

The response for this request is a JSON schema. The schema will define the structure of the response body in a machine-readable format, allowing for validation and documentation of the response.

[
    {
        "number": "<string>",
        "country_code_iso": "<string>",
        "capabilities": [
            "<string>"
        ],
        "currency": "<string>",
        "rate": 0.0
    }
]

Request

Header Params

Body Params application/json

Example

{
    "country_code_iso": "<country_code_iso>",
    "country_code": 0,
    "capabilities": "<capabilities>", // This only works for RSA numbers
    "starts_with": "<starts_with>", // max_length=15, this excludes country code
    "ends_with": "<ends_with>", // max_length=15
    "contains": "<contains>", // max_length=15
    "prefix_type": "<prefix_type>" // [LOCAL,MOBILE,NATIONAL,TOLL_FREE]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201

application/json

Bodyapplication/json

Example

[
  {
    "number": "consequat est",
    "target_number": "in",
    "country": "consectetur incididunt aliquip sunt",
    "features": [
      "voluptate ex nisi",
      "aute dolor quis magna"
    ],
    "meta": {},
    "webhooks": [
      "commodo quis minim",
      "et exercitation"
    ],
    "tts": "minim cupidatat",
    "whisper_file": "aliquip ea",
    "call_tracking": "irure eu",
    "record_call_file": "veniam amet nostrud Lorem",
    "keep_number_file": "ut fugiat dolor",
    "voicemail_lite_file": "aliquip Excepteur labor",
    "capture_digits_file": "do ad officia dolor",
    "keywords": [
      "eu elit dolore cillum",
      "Lorem Duis culpa non"
    ],
    "issued_date": "quis in minim",
    "billing_anniversary": "quis cupidatat elit",
    "last_called": "fugiat ut"
  },
  {
    "number": "sunt aliquip Excepteur ea",
    "target_number": "eiusmod elit veniam",
    "country": "amet et repreh",
    "features": [
      "tempor magna deserunt",
      "Lorem sint cupidatat"
    ],
    "meta": {},
    "webhooks": [
      "q",
      "deserunt"
    ],
    "tts": "et est",
    "whisper_file": "aliqua",
    "call_tracking": "officia aliqua",
    "record_call_file": "aliqua",
    "keep_number_file": "proident enim cillum Lorem",
    "voicemail_lite_file": "dolor ex id Duis",
    "capture_digits_file": "in nostrud laboris mollit",
    "keywords": [
      "ipsum",
      "sit velit"
    ],
    "issued_date": "deserunt mollit dolor",
    "billing_anniversary": "sit sed deserunt amet",
    "last_called": "amet ut est"
  }
]

Request#

Request Body#

Response#

Request

Request Code Samples

Responses

Request

Request Body

Response