Rate this page:

PSTNBlacklist

Methods

AddPstnBlackListItem

Copy URL

Add a new phone number to the PSTN blacklist. BlackList works for numbers that are purchased from Voximplant only. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.

AddPstnBlackListItem example

AddPstnBlackListItem example

Parameters

  • pstn_blacklist_phone:

    string

    Optional

    The phone number in format e164 or regex pattern

Returns

  • result:

    number

    1

  • pstn_blacklist_id:

    number

    The PSTN black list item ID.

SetPstnBlackListItem

Copy URL

Update the PSTN blacklist item. BlackList works for numbers that are purchased from Voximplant only. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.

SetPstnBlackListItem example

SetPstnBlackListItem example

Parameters

  • pstn_blacklist_id:

    number

    Optional

    The PSTN black list item ID.

  • pstn_blacklist_phone:

    string

    Optional

    The new phone number in format e164.

Returns

  • result:

    number

    1

DelPstnBlackListItem

Copy URL

Remove phone number from the PSTN blacklist.

DelPstnBlackListItem example

DelPstnBlackListItem example

Parameters

  • pstn_blacklist_id:

    number

    Optional

    The PSTN black list item ID.

Returns

  • result:

    number

    1

GetPstnBlackList

Copy URL

Get the whole PSTN blacklist.

GetPstnBlackList example

GetPstnBlackList example

Parameters

  • pstn_blacklist_id:

    number

    Optional

    The PSTN black list item ID for filter.

  • pstn_blacklist_phone:

    string

    Optional

    The phone number in format e164 for filter.

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count.

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output.

Returns

  • total_count:

    number

    The total found phone numbers count.

  • count:

    number

    The returned phone numbers count.