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.

Télécharger la spécification OpenAPI

Custom Fraud Rules

Operations for managing specific fraud rules per product.

Opérations disponibles

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

product

string

Exigée

Il doit s'agir de l'un d'entre eux :SMSVOICE

Demande de renseignements Paramètres

page_size

integer(int32)

Défaut100

Page size in Integer format

page

integer(int32)

Défaut1

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

Réponses
Type de contenu
application/json

page

integer(int32)

exemple1

page_size

integer(int32)

exemple100

total_pages

integer(int32)

exemple5

total_items

integer(int32)

exemple450

_embedded

object

entries

array

country

string

exempleGB

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

product

string

exempleSMS

string

exempleabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

_links

object

first

object

href

string

exemplehttps://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

exemplehttps://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

exemplehttps://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

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

self link

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corps de la demande
Type de contenu
application/json

product

string

exempleSMS

Product type (SMS or VOICE)

Il doit s'agir de l'un d'entre eux :VOICESMS

country

string

exempleGB

ISO country code

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

Exemple Demande

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

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

Réponses
Type de contenu
application/json

country

string

exempleGB

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

product

string

exempleSMS

string

exempleabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Corps de la demande
Type de contenu
application/json

product

string

exempleSMS

Product type (SMS or VOICE)

Il doit s'agir de l'un d'entre eux :VOICESMS

country

string

exempleGB

ISO country code

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

Exemple Demande

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

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

Réponses
Type de contenu
application/json

Created

country

string

exempleGB

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

product

string

exempleSMS

string

exempleabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

product

string

Exigée

Il doit s'agir de l'un d'entre eux :SMSVOICE

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses
Type de contenu
application/json

country

string

exempleGB

interval

integer(int32)

exemple60

threshold

integer(int32)

exemple10

product

string

exempleSMS

string

exempleabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

product

string

Exigée

Il doit s'agir de l'un d'entre eux :SMSVOICE

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses

No Content

AIT protection

Artificial Inflation of Traffic protection configuration.

Opérations disponibles

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

product

string

Exigée

Défautsms

product type

Il doit s'agir de l'un d'entre eux :sms

Réponses
Type de contenu
application/json

AIT protection config response

data

object

protection_enabled

boolean

Exigée

exempletrue

used to turn on/off AIT protection

default_protection_level

string

exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Exigée

exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Exigée

exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone

_links

object

self

object

href

string

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

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

product

string

Exigée

Défautsms

product type

Il doit s'agir de l'un d'entre eux :sms

Corps de la demande
Type de contenu
application/json

data

object

protection_enabled

boolean

Exigée

exempletrue

used to turn on/off AIT protection

default_protection_level

string

exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Exigée

exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Exigée

exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone

Exemple Demande

{
   "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"
         }
      ]
   }
}

Réponses
Type de contenu
application/json

AIT protection config response

data

object

protection_enabled

boolean

Exigée

exempletrue

used to turn on/off AIT protection

default_protection_level

string

exemplestandard

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

Il doit s'agir de l'un d'entre eux :highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Exigée

exempleUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Exigée

exemplehigh

AIT protection level

Il doit s'agir de l'un d'entre eux :highstandardnone

_links

object

self

object

href

string

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

Exemple Réponse

{
   "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.

Opérations disponibles

Create rule

Create a new fraud rule based on phone number prefixes.

posthttps://api.nexmo.com/v0.1/fraud-defender/rules

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Corps de la demande
Type de contenu
application/json

product

string

Exigée

exemplesms

Il doit s'agir de l'un d'entre eux :voicesms

prefix

string

Exigée

Max15

exemple44

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

Exigée

exempleMy custom prefix rule

Human readable reason

action

string

Exigée

exempleblock

Il doit s'agir de l'un d'entre eux :blockallow

status

string

exempleactive

Il doit s'agir de l'un d'entre eux :activearchived

Exemple Demande

{
   "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"
}

Réponses
Type de contenu
application/json

rule operation success

string

exempletest-id

product

string

exemplesms

Il doit s'agir de l'un d'entre eux :voicesms

prefix

string

exemple44

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

exemplefrom

Il doit s'agir de l'un d'entre eux :fromto

traffic_direction

string

Défautoutbound

exempleoutbound

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

action

string

exempleblock

Il doit s'agir de l'un d'entre eux :blockallow

reason

string

exempleMy custom prefix rule

Human readable reason

permission

string

exempleedit

Il doit s'agir de l'un d'entre eux :viewedit

status

string

exempleactive

Il doit s'agir de l'un d'entre eux :activearchived

created_timestamp

string

exemple2022-12-09T18:19:26

updated_timestamp

string

exemple2022-11-09T18:19:26

archived_timestamp

string

exemple2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Demande de renseignements Paramètres

product

string

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

Il doit s'agir de l'un d'entre eux :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

Défauttrue

defines whether to display default rules or not

show_custom_rules

boolean

Défauttrue

show custom rules flag

page_size

string

Défaut150

page size parameter, starts from 1

page

string

Défaut1

page offset parameter, starts from 1

sort

string

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

Il doit s'agir de l'un d'entre eux :productprefixtraffic

order

string

Défautdesc

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

Il doit s'agir de l'un d'entre eux :ascdesc

Réponses
Type de contenu
application/json

rule listing success

_links

object

first

object

href

string

exemplehttps://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

exemplehttps://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

exemplehttps://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

exemplehttps://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

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

self link

page

object

number

exemple2

Page number

size

number

exemple3

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

totalElements

number

exemple11

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

totalPages

number

exemple4

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

_embedded

object

rules

array

string

exempletest-id

product

string

exemplesms

Il doit s'agir de l'un d'entre eux :voicesms

prefix

string

exemple44

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

exemplefrom

Il doit s'agir de l'un d'entre eux :fromto

traffic_direction

string

Défautoutbound

exempleoutbound

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

action

string

exempleblock

Il doit s'agir de l'un d'entre eux :blockallow

reason

string

exempleMy custom prefix rule

Human readable reason

permission

string

exempleedit

Il doit s'agir de l'un d'entre eux :viewedit

status

string

exempleactive

Il doit s'agir de l'un d'entre eux :activearchived

created_timestamp

string

exemple2022-12-09T18:19:26

updated_timestamp

string

exemple2022-11-09T18:19:26

archived_timestamp

string

exemple2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemple Réponse

{
   "_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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses
Type de contenu
application/json

rule operation success

string

exempletest-id

product

string

exemplesms

Il doit s'agir de l'un d'entre eux :voicesms

prefix

string

exemple44

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

exemplefrom

Il doit s'agir de l'un d'entre eux :fromto

traffic_direction

string

Défautoutbound

exempleoutbound

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

action

string

exempleblock

Il doit s'agir de l'un d'entre eux :blockallow

reason

string

exempleMy custom prefix rule

Human readable reason

permission

string

exempleedit

Il doit s'agir de l'un d'entre eux :viewedit

status

string

exempleactive

Il doit s'agir de l'un d'entre eux :activearchived

created_timestamp

string

exemple2022-12-09T18:19:26

updated_timestamp

string

exemple2022-11-09T18:19:26

archived_timestamp

string

exemple2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemple Réponse

{
   "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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Réponses

No Content

Update rule by id

Update specific fields of an existing fraud rule.

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

exempleabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corps de la demande
Type de contenu
application/json

reason

string

Exigée

exempleMy custom prefix rule

Human readable reason

Exemple Demande

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

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

Réponses
Type de contenu
application/json

rule operation success

string

exempletest-id

product

string

exemplesms

Il doit s'agir de l'un d'entre eux :voicesms

prefix

string

exemple44

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

exemplefrom

Il doit s'agir de l'un d'entre eux :fromto

traffic_direction

string

Défautoutbound

exempleoutbound

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

action

string

exempleblock

Il doit s'agir de l'un d'entre eux :blockallow

reason

string

exempleMy custom prefix rule

Human readable reason

permission

string

exempleedit

Il doit s'agir de l'un d'entre eux :viewedit

status

string

exempleactive

Il doit s'agir de l'un d'entre eux :activearchived

created_timestamp

string

exemple2022-12-09T18:19:26

updated_timestamp

string

exemple2022-11-09T18:19:26

archived_timestamp

string

exemple2022-10-09T18:19:26

_links

object

self

object

href

string

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

Exemple Réponse

{
   "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"
      }
   }
}

Erreurs

Voici une liste non exhaustive des codes d'erreur susceptibles de se produire lors de l'utilisation de cette API.

Ces codes s'ajoutent à ceux de notre site codes d'erreur génériques.

Code	Informations
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

Opérations disponibles

List custom fraud rules

Authentification

Trajectoire Paramètres

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Edit custom fraud rule by ID

Authentification

Trajectoire Paramètres

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Create custom fraud rule

Authentification

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Get custom fraud rule by product and id

Authentification

Trajectoire Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Delete custom fraud rule by ID

Authentification

Trajectoire Paramètres

Réponses

AIT protection

Opérations disponibles

Get AIT configuration

Authentification

Trajectoire Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Create or update AIT configuration

Authentification

Trajectoire Paramètres

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Rules

Opérations disponibles

Create rule

Authentification

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Listing rules

Authentification

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Get rule by id

Authentification

Trajectoire Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Archive rule by id

Authentification

Trajectoire Paramètres

Réponses

Update rule by id

Authentification

Trajectoire Paramètres

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Erreurs

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json