Fraud Prevention API

Version 0.1

The Fraud Prevention 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

Custom Fraud Rules

Operations for managing specific fraud rules per product.

Verfügbare Operationen

List custom fraud rules

Returns a paginated list of custom fraud rules filtered by product type.

gethttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/: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

Muss eines der folgenden sein:SMSVOICE

Abfrage Parameter

page_size

integer(int32)

Standard100

Page size in Integer format

page

integer(int32)

Standard1

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

page

integer(int32)

Beispiel1

page_size

integer(int32)

Beispiel100

total_pages

integer(int32)

Beispiel5

total_items

integer(int32)

Beispiel450

_embedded

object

entries

array

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

_links

object

first

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100

first link of the paginated result set

last

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=4&size=100

last link of the paginated result set

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100

previous link of the paginated result set

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS?page=1&size=100

self link

Beispiel Antwort

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

Edit custom fraud rule by ID

Update an existing fraud rule configuration using its unique identifier.

puthttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-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

product

string

BeispielSMS

Product type (SMS or VOICE)

Muss eines der folgenden sein:VOICESMS

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

Beispiel Anfrage

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

Antworten
Inhalt Typ
application/json

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Beispiel Antwort

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

Create custom fraud rule

Create a new custom fraud rule for a specific product and country.

posthttps://api.nexmo.com/v0.1/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

Product type (SMS or VOICE)

Muss eines der folgenden sein:VOICESMS

country

string

BeispielGB

ISO country code

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

Beispiel Anfrage

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

{
   "product": "SMS",
   "country": "GB",
   "interval": 60,
   "threshold": 10
}

Antworten
Inhalt Typ
application/json

Created

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Beispiel Antwort

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

Get custom fraud rule by product and id

Retrieve detailed information for a specific custom fraud rule.

gethttps://api.nexmo.com/v0.1/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

Muss eines der folgenden sein:SMSVOICE

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten
Inhalt Typ
application/json

country

string

BeispielGB

interval

integer(int32)

Beispiel60

threshold

integer(int32)

Beispiel10

product

string

BeispielSMS

string

Beispielabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configuration/custom-rules/SMS/e21ace94-54fa-4365-a824-38033dc06779

self link

Beispiel Antwort

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

Delete custom fraud rule by ID

Permanently remove a custom fraud rule from the system.

deletehttps://api.nexmo.com/v0.1/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

Muss eines der folgenden sein:SMSVOICE

string

Erforderlich

Beispielabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Antworten

No Content

AIT protection

Artificial Inflation of Traffic protection configuration.

Verfügbare Operationen

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

gethttps://api.nexmo.com/v0.1/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

data

object

protection_enabled

boolean

Erforderlich

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS

Beispiel Antwort

{
   "data": {
      "protection_enabled": true,
      "default_protection_level": "standard",
      "protection_level_per_country": [
         {
            "country": "US",
            "protection_level": "standard"
         }
      ],
      "_links": {
         "self": {
            "href": "https://api.nexmo.com/v0.1/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/v0.1/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

Erforderlich

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

data

object

protection_enabled

boolean

Erforderlich

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/configurations/protections/ait/SMS

Beispiel Antwort

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

Rules

General fraud rule management and listing.

Verfügbare Operationen

Create rule

Create a new fraud rule based on phone number prefixes.

posthttps://api.nexmo.com/v0.1/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:activearchived

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

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

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:activearchived

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

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/v0.1/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/v0.1/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

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

Muss eines der folgenden sein:voicesms

prefix

string

phone prefix filter

reason

string

reason filter

action

string

action filter

rule_type

string

rule type filter (allow, block)

status

string

filter rules by status (active, archived, all)

show_default_rules

boolean

Standardtrue

defines whether to display default rules or not

show_custom_rules

boolean

Standardtrue

show custom rules flag

page_size

string

Standard150

page size parameter, starts from 1

page

string

Standard1

page offset parameter, starts from 1

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

_links

object

first

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3

first link of the paginated result set

last

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=4&page_size=3

last link of the paginated result set

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=3&page_size=3

next link of the paginated result set

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3

previous link of the paginated result set

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=2&page_size=3

self link

page

object

number

Beispiel2

Page number

size

number

Beispiel3

Page size number or 0 if no entries found. Default is 150.

totalElements

number

Beispiel11

Total entries for the result set or 0 if no entries found

totalPages

number

Beispiel4

Total pages for the paginated result set or 1 if no entries found

_embedded

object

rules

array

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

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:activearchived

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

Beispiel Antwort

{
   "_links": {
      "first": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "last": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=4&page_size=3"
      },
      "next": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=3&page_size=3"
      },
      "prev": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=1&page_size=3"
      },
      "self": {
         "href": "https://api.nexmo.com/v0.1/fraud-defender/rules?order=asc&page=2&page_size=3"
      }
   },
   "page": {
      "number": 2,
      "size": 3,
      "totalElements": 11,
      "totalPages": 4
   },
   "_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/v0.1/fraud-defender/rules/test-id"
               }
            }
         }
      ]
   }
}

Get rule by id

Retrieve a specific fraud rule by its unique ID.

gethttps://api.nexmo.com/v0.1/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

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

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:activearchived

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

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/v0.1/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/v0.1/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

Update rule by id

Update specific fields of an existing fraud rule.

patchhttps://api.nexmo.com/v0.1/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

string

Beispieltest-id

product

string

Beispielsms

Muss eines der folgenden sein:voicesms

prefix

string

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:activearchived

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

self

object

href

string

Beispielhttps://api.nexmo.com/v0.1/fraud-defender/rules/test-id

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/v0.1/fraud-defender/rules/test-id"
      }
   }
}

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.

Fraud Prevention API

Custom Fraud Rules

Verfügbare Operationen

List custom fraud rules

Authentifizierung

Pfad Parameter

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Edit custom fraud rule by ID

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Create custom fraud rule

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get custom fraud rule by product and id

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Delete custom fraud rule by ID

Authentifizierung

Pfad Parameter

Antworten

AIT protection

Verfügbare Operationen

Get AIT configuration

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Create or update AIT configuration

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Rules

Verfügbare Operationen

Create rule

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Listing rules

Authentifizierung

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get rule by id

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Archive rule by id

Authentifizierung

Pfad Parameter

Antworten

Update rule by id

Authentifizierung

Pfad Parameter

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Fehler

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

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

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json