Fraud Prevention API

Versión 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.

Descargar la especificación OpenAPI

Custom Fraud Rules

Operations for managing specific fraud rules per product.

Operaciones 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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

product

string

Requerido

Debe ser uno de:SMSVOICE

Consulta Parámetros

page_size

integer(int32)

Por defecto100

Page size in Integer format

page

integer(int32)

Por defecto1

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

Respuestas
Tipo de contenido
application/json

page

integer(int32)

ejemplo1

page_size

integer(int32)

ejemplo100

total_pages

integer(int32)

ejemplo5

total_items

integer(int32)

ejemplo450

_embedded

object

entries

array

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

product

string

ejemploSMS

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

_links

object

first

object

href

string

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

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

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

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

self link

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Cuerpo de la solicitud
Tipo de contenido
application/json

product

string

ejemploSMS

Product type (SMS or VOICE)

Debe ser uno de:VOICESMS

country

string

ejemploGB

ISO country code

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

product

string

ejemploSMS

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

product

string

ejemploSMS

Product type (SMS or VOICE)

Debe ser uno de:VOICESMS

country

string

ejemploGB

ISO country code

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Created

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

product

string

ejemploSMS

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

product

string

Requerido

Debe ser uno de:SMSVOICE

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas
Tipo de contenido
application/json

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo10

product

string

ejemploSMS

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

self

object

href

string

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

self link

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

product

string

Requerido

Debe ser uno de:SMSVOICE

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas

No Content

AIT protection

Artificial Inflation of Traffic protection configuration.

Operaciones 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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

product

string

Requerido

Por defectosms

product type

Debe ser uno de:sms

Respuestas
Tipo de contenido
application/json

AIT protection config response

data

object

protection_enabled

boolean

Requerido

ejemplotrue

used to turn on/off AIT protection

default_protection_level

string

ejemplostandard

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

Debe ser uno de:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Requerido

ejemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Requerido

ejemplohigh

AIT protection level

Debe ser uno de:highstandardnone

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

product

string

Requerido

Por defectosms

product type

Debe ser uno de:sms

Cuerpo de la solicitud
Tipo de contenido
application/json

data

object

protection_enabled

boolean

Requerido

ejemplotrue

used to turn on/off AIT protection

default_protection_level

string

ejemplostandard

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

Debe ser uno de:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Requerido

ejemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Requerido

ejemplohigh

AIT protection level

Debe ser uno de:highstandardnone

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

AIT protection config response

data

object

protection_enabled

boolean

Requerido

ejemplotrue

used to turn on/off AIT protection

default_protection_level

string

ejemplostandard

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

Debe ser uno de:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Requerido

ejemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Requerido

ejemplohigh

AIT protection level

Debe ser uno de:highstandardnone

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Operaciones disponibles

Create rule

Create a new fraud rule based on phone number prefixes.

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

product

string

Requerido

ejemplosms

Debe ser uno de:voicesms

prefix

string

Requerido

Max15

ejemplo44

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

Requerido

ejemploMy custom prefix rule

Human readable reason

action

string

Requerido

ejemploblock

Debe ser uno de:blockallow

status

string

ejemploactive

Debe ser uno de:activearchived

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

rule operation success

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

ejemplo44

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

ejemplofrom

Debe ser uno de:fromto

traffic_direction

string

Por defectooutbound

ejemplooutbound

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

action

string

ejemploblock

Debe ser uno de:blockallow

reason

string

ejemploMy custom prefix rule

Human readable reason

permission

string

ejemploedit

Debe ser uno de:viewedit

status

string

ejemploactive

Debe ser uno de:activearchived

created_timestamp

string

ejemplo2022-12-09T18:19:26

updated_timestamp

string

ejemplo2022-11-09T18:19:26

archived_timestamp

string

ejemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

product

string

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

Debe ser uno de: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

Por defectotrue

defines whether to display default rules or not

show_custom_rules

boolean

Por defectotrue

show custom rules flag

page_size

string

Por defecto150

page size parameter, starts from 1

page

string

Por defecto1

page offset parameter, starts from 1

sort

string

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

Debe ser uno de:productprefixtraffic

order

string

Por defectodesc

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

Debe ser uno de:ascdesc

Respuestas
Tipo de contenido
application/json

rule listing success

_links

object

first

object

href

string

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

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

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

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

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

self link

page

object

number

ejemplo2

Page number

size

number

ejemplo3

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

totalElements

number

ejemplo11

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

totalPages

number

ejemplo4

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

_embedded

object

rules

array

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

ejemplo44

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

ejemplofrom

Debe ser uno de:fromto

traffic_direction

string

Por defectooutbound

ejemplooutbound

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

action

string

ejemploblock

Debe ser uno de:blockallow

reason

string

ejemploMy custom prefix rule

Human readable reason

permission

string

ejemploedit

Debe ser uno de:viewedit

status

string

ejemploactive

Debe ser uno de:activearchived

created_timestamp

string

ejemplo2022-12-09T18:19:26

updated_timestamp

string

ejemplo2022-11-09T18:19:26

archived_timestamp

string

ejemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas
Tipo de contenido
application/json

rule operation success

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

ejemplo44

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

ejemplofrom

Debe ser uno de:fromto

traffic_direction

string

Por defectooutbound

ejemplooutbound

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

action

string

ejemploblock

Debe ser uno de:blockallow

reason

string

ejemploMy custom prefix rule

Human readable reason

permission

string

ejemploedit

Debe ser uno de:viewedit

status

string

ejemploactive

Debe ser uno de:activearchived

created_timestamp

string

ejemplo2022-12-09T18:19:26

updated_timestamp

string

ejemplo2022-11-09T18:19:26

archived_timestamp

string

ejemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas

No Content

Update rule by id

Update specific fields of an existing fraud rule.

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Cuerpo de la solicitud
Tipo de contenido
application/json

reason

string

Requerido

ejemploMy custom prefix rule

Human readable reason

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

rule operation success

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

ejemplo44

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

ejemplofrom

Debe ser uno de:fromto

traffic_direction

string

Por defectooutbound

ejemplooutbound

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

action

string

ejemploblock

Debe ser uno de:blockallow

reason

string

ejemploMy custom prefix rule

Human readable reason

permission

string

ejemploedit

Debe ser uno de:viewedit

status

string

ejemploactive

Debe ser uno de:activearchived

created_timestamp

string

ejemplo2022-12-09T18:19:26

updated_timestamp

string

ejemplo2022-11-09T18:19:26

archived_timestamp

string

ejemplo2022-10-09T18:19:26

_links

object

self

object

href

string

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

Ejemplo Respuesta

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

Errores

La siguiente es una lista no exhaustiva de códigos de error que pueden producirse al utilizar esta API.

Estos códigos se suman a cualquiera de nuestros códigos de error genéricos.

Código	Información
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

Operaciones disponibles

List custom fraud rules

Autenticación

Ruta Parámetros

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Edit custom fraud rule by ID

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Create custom fraud rule

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get custom fraud rule by product and id

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Delete custom fraud rule by ID

Autenticación

Ruta Parámetros

Respuestas

AIT protection

Operaciones disponibles

Get AIT configuration

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Create or update AIT configuration

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Rules

Operaciones disponibles

Create rule

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Listing rules

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get rule by id

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Archive rule by id

Autenticación

Ruta Parámetros

Respuestas

Update rule by id

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Errores

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json