Fraud Defender API

Version 1

The Fraud Defender API is a set of APIs supporting Fraud detection including managing own fraud rules. For more details, please visit the Vonage Developer Center.

OpenAPI-Spezifikation herunterladen

Traffic Rules

Operations to manage traffic rules.

Verfügbare Operationen

Create rule

Create a new fraud rule based on phone number prefixes.

posthttps://api.nexmo.com/v1/fraud-defender/rules

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

product

string

Erforderlich

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

Erforderlich

Max15

Beispiel44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

reason

string

Erforderlich

BeispielMy custom prefix rule

Human readable reason

action

string

Erforderlich

Beispielblock

Muss eines der folgenden sein:blockallow

status

string

Beispielactive

Muss eines der folgenden sein:activearchivedall

Beispiel Anfrage

{
   "product": "sms",
   "prefix": "44",
   "reason": "My custom prefix rule",
   "action": "block",
   "status": "active"
}

{
   "product": "sms",
   "prefix": "44",
   "reason": "My custom prefix rule",
   "action": "block",
   "status": "active"
}

Antworten
Inhalt Typ
application/json

rule operation success

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

Max15

Beispiel44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

Beispielfrom

Muss eines der folgenden sein:fromto

traffic_direction

string

Standardoutbound

Beispieloutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

Beispielblock

Muss eines der folgenden sein:blockallow

reason

string

BeispielMy custom prefix rule

Human readable reason

permission

string

Beispieledit

Muss eines der folgenden sein:viewedit

status

string

Beispielactive

Muss eines der folgenden sein:activearchivedall

created_timestamp

string

Beispiel2022-12-09T18:19:26

updated_timestamp

string

Beispiel2022-11-09T18:19:26

archived_timestamp

string

Beispiel2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules/test-id"
      }
   }
}

Listing rules

List all existing fraud rules with support for filtering by prefix, action, and status.

gethttps://api.nexmo.com/v1/fraud-defender/rules

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Abfrage Parameter

product

string

Beispielsms

if passed, lists rules for that product. if not, gives such for all product types

Muss eines der folgenden sein:voicesms

prefix

string

Max15

Beispiel44

phone prefix filter

reason

string

BeispielMy custom prefix rule

reason filter

action

string

Beispielblock

action filter

Muss eines der folgenden sein:blockallow

rule_type

string

rule type filter (allow, block)

Muss eines der folgenden sein:allowblock

status

string

Beispielactive

filter rules by status (active, archived, all)

Muss eines der folgenden sein:activearchivedall

show_default_rules

boolean

Standardtrue

defines whether to display default rules or not

show_custom_rules

boolean

Standardtrue

show custom rules flag

page_size

integer

Beispiel10

Page size in Integer format

page

integer

Min1

Beispiel2

Page number in Integer format

sort

string

sort by product, prefix or traffic and it's case-insensitive

Muss eines der folgenden sein:productprefixtraffic

order

string

Standarddesc

sort order either asc or desc and it's case-insensitive

Muss eines der folgenden sein:ascdesc

Antworten
Inhalt Typ
application/json

rule listing success

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

page

object

page_size

integer

Beispiel10

Items per page

page

integer

Min1

Beispiel2

Page Offset

total_pages

integer

Min1

Beispiel100

Number of pages in the entire result set

total_items

integer

Beispiel100

Number of items in the entire result set

_embedded

object

rules

array

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

Max15

Beispiel44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

Beispielfrom

Muss eines der folgenden sein:fromto

traffic_direction

string

Standardoutbound

Beispieloutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

Beispielblock

Muss eines der folgenden sein:blockallow

reason

string

BeispielMy custom prefix rule

Human readable reason

permission

string

Beispieledit

Muss eines der folgenden sein:viewedit

status

string

Beispielactive

Muss eines der folgenden sein:activearchivedall

created_timestamp

string

Beispiel2022-12-09T18:19:26

updated_timestamp

string

Beispiel2022-11-09T18:19:26

archived_timestamp

string

Beispiel2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "links": {
      "first": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=4&page_size=3"
      },
      "next": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=3&page_size=3"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules?order=asc&page=2&page_size=3"
      }
   },
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_embedded": {
      "rules": [
         {
            "id": "test-id",
            "product": "sms",
            "prefix": "44",
            "direction": "from",
            "traffic_direction": "outbound",
            "action": "block",
            "reason": "My custom prefix rule",
            "permission": "edit",
            "status": "active",
            "created_timestamp": "2022-12-09T18:19:26",
            "updated_timestamp": "2022-11-09T18:19:26",
            "archived_timestamp": "2022-10-09T18:19:26",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/fraud-defender/rules/test-id"
               }
            }
         }
      ]
   }
}

Get rule by id

Retrieve a specific fraud rule by its unique ID.

gethttps://api.nexmo.com/v1/fraud-defender/rules/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten
Inhalt Typ
application/json

rule operation success

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

Max15

Beispiel44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

Beispielfrom

Muss eines der folgenden sein:fromto

traffic_direction

string

Standardoutbound

Beispieloutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

Beispielblock

Muss eines der folgenden sein:blockallow

reason

string

BeispielMy custom prefix rule

Human readable reason

permission

string

Beispieledit

Muss eines der folgenden sein:viewedit

status

string

Beispielactive

Muss eines der folgenden sein:activearchivedall

created_timestamp

string

Beispiel2022-12-09T18:19:26

updated_timestamp

string

Beispiel2022-11-09T18:19:26

archived_timestamp

string

Beispiel2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules/test-id"
      }
   }
}

Archive rule by id

Mark a rule as archived. Archived rules are no longer active in the fraud detection flow.

deletehttps://api.nexmo.com/v1/fraud-defender/rules/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten

No Content - Resource successfully deleted

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

Update rule by id

Update specific fields of an existing fraud rule.

patchhttps://api.nexmo.com/v1/fraud-defender/rules/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Anfrage Körper
Inhalt Typ
application/json

reason

string

Erforderlich

BeispielMy custom prefix rule

Human readable reason

Beispiel Anfrage

{
   "reason": "My custom prefix rule"
}

{
   "reason": "My custom prefix rule"
}

Antworten
Inhalt Typ
application/json

rule operation success

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

Max15

Beispiel44

The prefix attribute is used to check whether a phone number begins with a particular sequence of digits. It's not related to phone number prefixes.

direction

string

Beispielfrom

Muss eines der folgenden sein:fromto

traffic_direction

string

Standardoutbound

Beispieloutbound

Outbound rules apply to traffic generated from you API Key. Inbound rules apply to traffic sent to your phone numbers.

action

string

Beispielblock

Muss eines der folgenden sein:blockallow

reason

string

BeispielMy custom prefix rule

Human readable reason

permission

string

Beispieledit

Muss eines der folgenden sein:viewedit

status

string

Beispielactive

Muss eines der folgenden sein:activearchivedall

created_timestamp

string

Beispiel2022-12-09T18:19:26

updated_timestamp

string

Beispiel2022-11-09T18:19:26

archived_timestamp

string

Beispiel2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "test-id",
   "product": "sms",
   "prefix": "44",
   "direction": "from",
   "traffic_direction": "outbound",
   "action": "block",
   "reason": "My custom prefix rule",
   "permission": "edit",
   "status": "active",
   "created_timestamp": "2022-12-09T18:19:26",
   "updated_timestamp": "2022-11-09T18:19:26",
   "archived_timestamp": "2022-10-09T18:19:26",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/rules/test-id"
      }
   }
}

AIT Protection

Operations to manage AIT Protection.

Verfügbare Operationen

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

gethttps://api.nexmo.com/v1/fraud-defender/configurations/protections/ait/:product

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Standardsms

product type

Muss eines der folgenden sein:sms

Antworten
Inhalt Typ
application/json

AIT protection config response

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

data

object

protection_enabled

boolean

Beispieltrue

used to turn on/off AIT protection

default_protection_level

string

Beispielstandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Muss eines der folgenden sein:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Erforderlich

BeispielUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Erforderlich

Beispielhigh

AIT protection level

Muss eines der folgenden sein:highstandardnone

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ],
      "_links": {
         "self": {
            "href": "https://api.nexmo.com/v1/fraud-defender/configurations/protections/ait/SMS"
         }
      }
   }
}

Create or update AIT configuration

Enable or modify AIT protection settings globally or per country.

puthttps://api.nexmo.com/v1/fraud-defender/configurations/protections/ait/:product

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Standardsms

product type

Muss eines der folgenden sein:sms

Anfrage Körper
Inhalt Typ
application/json

data

object

protection_enabled

boolean

Beispieltrue

used to turn on/off AIT protection

default_protection_level

string

Beispielstandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Muss eines der folgenden sein:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Erforderlich

BeispielUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Erforderlich

Beispielhigh

AIT protection level

Muss eines der folgenden sein:highstandardnone

Beispiel Anfrage

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ]
   }
}

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ]
   }
}

Antworten
Inhalt Typ
application/json

AIT protection config response

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

data

object

protection_enabled

boolean

Beispieltrue

used to turn on/off AIT protection

default_protection_level

string

Beispielstandard

Required if protection_enabled is set to true. Default AIT protection level will be used for countries where no specific per-country configuration exists.

Muss eines der folgenden sein:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Erforderlich

BeispielUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Erforderlich

Beispielhigh

AIT protection level

Muss eines der folgenden sein:highstandardnone

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "high"
         }
      ],
      "_links": {
         "self": {
            "href": "https://api.nexmo.com/v1/fraud-defender/configurations/protections/ait/SMS"
         }
      }
   }
}

SMS Burst Protection

Operations to manage limits on SMS traffic bursts to prevent fraud.

Verfügbare Operationen

List SMS Burst Protection entries

Retrieve a paginated list of all SMS Burst Protection configurations.

gethttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Abfrage Parameter

page

integer

Min1

Beispiel2

Page number in Integer format

page_size

integer

Beispiel10

Page size in Integer format

Antworten
Inhalt Typ
application/json

Successful operation

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page

object

page_size

integer

Beispiel10

Items per page

page

integer

Min1

Beispiel2

Page Offset

total_pages

integer

Min1

Beispiel100

Number of pages in the entire result set

total_items

integer

Beispiel100

Number of items in the entire result set

_embedded

object

entries

array

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_embedded": {
      "entries": [
         {
            "id": "abcdef01-2345-6789-abcd-ef0123456789",
            "destination_countries": [
               "DZ"
            ],
            "block_value": 1,
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789"
               }
            }
         }
      ]
   },
   "links": {
      "first": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst?page=1&size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst?page=4&size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst?page=1&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst?page=1&size=100"
      }
   }
}

Create new SMS Burst Protection entity

Defines a new burst protection limit for a specific set of destination countries.

posthttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

destination_countries

array

Erforderlich

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Erforderlich

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

Beispiel Anfrage

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

Antworten
Inhalt Typ
application/json

Successful operation

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789"
      }
   }
}

Get SMS Burst Protection rule by ID

Fetch a specific burst protection entry using its unique identifier.

gethttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten
Inhalt Typ
application/json

Successful operation

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789"
      }
   }
}

Edit an existing SMS Burst Protection rule

puthttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Anfrage Körper
Inhalt Typ
application/json

destination_countries

array

Erforderlich

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Erforderlich

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

Beispiel Anfrage

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

{
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1
}

Antworten
Inhalt Typ
application/json

Successful operation

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

Internal ID, to be used as the ID when updating or deleting a record

destination_countries

array

List of destination countries

Verfügbare Werte:

DZ,AZ,BD,BB,BY,BJ,BG,EG,SV,GH,KZ,KG,LA,MV,MM,NG,PH,PK,PS,RU,LK,SD,SY,TJ,AE,UZ,BH,IR,IQ,IL,JO,KW,LB,OM,QA,SA,YE

block_value

integer

Beispiel1

Number of messages allowed in the 10 minutes time period, after which messages will be blocked.

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "destination_countries": [
      "DZ"
   ],
   "block_value": 1,
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/abcdef01-2345-6789-abcd-ef0123456789"
      }
   }
}

Delete SMS Burst Protection entity by id

Remove an SMS burst protection entry from the system.

deletehttps://api.nexmo.com/v1/fraud-defender/protection-configuration/absolute-burst/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten

No Content - Resource successfully deleted

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

Custom Fraud Alerts

Operations to manage thresholds and intervals for custom fraud detection logic.

Verfügbare Operationen

List custom fraud alerts

gethttps://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/:identifier

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

identifier

string

Erforderlich

Muss eines der folgenden sein:SMSVOICE

Abfrage Parameter

page_size

integer

Beispiel10

Page size in Integer format

page

integer

Min1

Beispiel2

Page number in Integer format

threshold

integer(int32)

Threshold value in Integer format

interval

integer(int32)

Interval value in Integer format it will be presented in minutes

countries

array

Array of ISO countries codes

Antworten
Inhalt Typ
application/json

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

page

object

page_size

integer

Beispiel10

Items per page

page

integer

Min1

Beispiel2

Page Offset

total_pages

integer

Min1

Beispiel100

Number of pages in the entire result set

total_items

integer

Beispiel100

Number of items in the entire result set

_embedded

object

entries

array

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "page": {
      "page_size": 10,
      "page": 2,
      "total_pages": 100,
      "total_items": 100
   },
   "_embedded": {
      "entries": [
         {
            "country": "GB",
            "interval": 60,
            "threshold": 100,
            "product": "sms",
            "id": "abcdef01-2345-6789-abcd-ef0123456789",
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
               }
            }
         }
      ]
   },
   "links": {
      "first": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=4&size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      },
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100"
      }
   }
}

Edit custom fraud alert by ID

puthttps://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/:identifier

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

identifier

string

Erforderlich

Anfrage Körper
Inhalt Typ
application/json

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel360

Interval in minutes. Supported values:

1 min: 1
5 min: 5
10 min: 10
15 min: 15
30 min: 30
45 min: 45
1 hour: 60
6 hour: 360
12 hour: 720
One day: 1440

Muss eines der folgenden sein:1510153045603607201440

threshold

integer(int32)

Beispiel100

Beispiel Anfrage

{
   "product": "sms",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

{
   "product": "sms",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

Antworten
Inhalt Typ
application/json

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "sms",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Create custom fraud alert

posthttps://api.nexmo.com/v1/fraud-defender/configuration/custom-rules

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel360

Interval in minutes. Supported values:

1 min: 1
5 min: 5
10 min: 10
15 min: 15
30 min: 30
45 min: 45
1 hour: 60
6 hour: 360
12 hour: 720
One day: 1440

Muss eines der folgenden sein:1510153045603607201440

threshold

integer(int32)

Beispiel100

Beispiel Anfrage

{
   "product": "sms",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

{
   "product": "sms",
   "country": "GB",
   "interval": 360,
   "threshold": 100
}

Antworten
Inhalt Typ
application/json

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "sms",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Get custom fraud alert by product and id

gethttps://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/:product/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Beispielsms

Muss eines der folgenden sein:voicesms

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten
Inhalt Typ
application/json

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel100

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Erforderlich

A single HAL link object

href

string

Erforderlich

Beispielhttps://api.vonage.com/v1/resources/abc123

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

Beispielapplication/json

Media type hint for the target resource

name

string

Beispielresource-name

Secondary key for selecting link objects

title

string

BeispielResource Title

Human-readable title for the link

Beispiel Antwort

{
   "country": "GB",
   "interval": 60,
   "threshold": 100,
   "product": "sms",
   "id": "abcdef01-2345-6789-abcd-ef0123456789",
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779"
      }
   }
}

Delete custom fraud alert by ID

deletehttps://api.nexmo.com/v1/fraud-defender/configuration/custom-rules/:product/:id

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

product

string

Erforderlich

Beispielsms

Muss eines der folgenden sein:voicesms

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten

No Content - Resource successfully deleted

Kopfzeile Parameter

X-Request-Id

string(uuid)

Beispielf94b4e56-604e-07e5-e5ad-5a7228618f81

A unique identifier for the request, used for tracking and debugging

Fehler

Im Folgenden finden Sie eine nicht erschöpfende Liste von Fehlercodes, die bei der Verwendung dieser API auftreten können.

Diese Codes gelten zusätzlich zu unseren generische Fehlercodes.

Code	Informationen
http:error:conflict	Rule couldn't be added as conflicts with currently existing rules
system:error:internal-error	Something went wrong.
http:error:validation-fail	There was an issue when validating fields. Please refer to the API specs
http:error:bad-request	Bad Request. Please refer to the API specs

Fraud Defender API

Traffic Rules

Verfügbare Operationen

Create rule

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Listing rules

Authentifizierung

Abfrage Parameter

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Get rule by id

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Archive rule by id

Authentifizierung

Pfad Parameter

Antworten

Kopfzeile Parameter

Update rule by id

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

AIT Protection

Verfügbare Operationen

Get AIT configuration

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Create or update AIT configuration

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

SMS Burst Protection

Verfügbare Operationen

List SMS Burst Protection entries

Authentifizierung

Abfrage Parameter

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Create new SMS Burst Protection entity

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Get SMS Burst Protection rule by ID

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Edit an existing SMS Burst Protection rule

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Kopfzeile Parameter

Beispiel Antwort

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json