Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface ListAvailableNumbersRequestData

    interface ListAvailableNumbersRequestData {
        capabilities?: string[];
        "numberPattern.pattern"?: string;
        "numberPattern.searchPattern"?: string;
        regionCode: string;
        size?: number;
        type: string;
    }
    Index

    Properties

    capabilities? numberPattern.pattern? numberPattern.searchPattern? regionCode size? type

    Properties

    capabilities?: string[]

    Number capabilities to filter by SMS and/or VOICE. When searching, indicate the capabilities of the number as SMS and/or VOICE. To search for a number capable of both, list both SMS and VOICE.

    "numberPattern.pattern"?: string

    Sequence of digits to search for. If you prefer or need certain digits in sequential order, you can enter the sequence of numbers here. For example, 2020.

    "numberPattern.searchPattern"?: string

    Search pattern to apply. The options are, START, CONTAIN, and END.

    regionCode: string

    Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Example: US, GB or SE.

    size?: number

    Optional. The maximum number of items to return.

    type: string

    Number type to filter by. Options include, MOBILE, LOCAL or TOLL_FREE.

    Settings

    Member Visibility

    On This Page

    Properties