Fraud Defender API

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

Descargar la especificación OpenAPI

Traffic Rules

Operations to manage traffic rules.

Operaciones disponibles

Create rule

Create a new fraud rule based on phone number prefixes.

posthttps://api.nexmo.com/v1/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:activearchivedall

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

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.

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

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

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

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

ejemplosms

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

Debe ser uno de:voicesms

prefix

string

Max15

ejemplo44

phone prefix filter

reason

string

ejemploMy custom prefix rule

reason filter

action

string

ejemploblock

action filter

Debe ser uno de:blockallow

rule_type

string

rule type filter (allow, block)

Debe ser uno de:allowblock

status

string

ejemploactive

filter rules by status (active, archived, all)

Debe ser uno de:activearchivedall

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

integer

ejemplo10

Page size in Integer format

page

integer

Min1

ejemplo2

Page number in Integer format

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

page

object

page_size

integer

ejemplo10

Items per page

page

integer

Min1

ejemplo2

Page Offset

total_pages

integer

Min1

ejemplo100

Number of pages in the entire result set

total_items

integer

ejemplo100

Number of items in the entire result set

_embedded

object

rules

array

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

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.

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

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

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.

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

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

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

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 - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-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

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemplotest-id

product

string

ejemplosms

Debe ser uno de:voicesms

prefix

string

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.

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

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

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

AIT Protection

Operations to manage AIT Protection.

Operaciones disponibles

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

data

object

protection_enabled

boolean

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

data

object

protection_enabled

boolean

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

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

Operaciones disponibles

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

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

page

integer

Min1

ejemplo2

Page number in Integer format

page_size

integer

ejemplo10

Page size in Integer format

Respuestas
Tipo de contenido
application/json

Successful operation

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

page

object

page_size

integer

ejemplo10

Items per page

page

integer

Min1

ejemplo2

Page Offset

total_pages

integer

Min1

ejemplo100

Number of pages in the entire result set

total_items

integer

ejemplo100

Number of items in the entire result set

_embedded

object

entries

array

string

ejemploabcdef01-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

Valores disponibles:

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

ejemplo1

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

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

destination_countries

array

Requerido

Valores disponibles:

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

Requerido

ejemplo1

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

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Successful operation

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemploabcdef01-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

Valores disponibles:

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

ejemplo1

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

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

Successful operation

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemploabcdef01-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

Valores disponibles:

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

ejemplo1

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

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

destination_countries

array

Requerido

Valores disponibles:

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

Requerido

ejemplo1

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

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Successful operation

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

string

ejemploabcdef01-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

Valores disponibles:

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

ejemplo1

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

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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 - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

ejemplof94b4e56-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.

Operaciones disponibles

List custom fraud alerts

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

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

identifier

string

Requerido

Debe ser uno de:SMSVOICE

Consulta Parámetros

page_size

integer

ejemplo10

Page size in Integer format

page

integer

Min1

ejemplo2

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

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

page

object

page_size

integer

ejemplo10

Items per page

page

integer

Min1

ejemplo2

Page Offset

total_pages

integer

Min1

ejemplo100

Number of pages in the entire result set

total_items

integer

ejemplo100

Number of items in the entire result set

_embedded

object

entries

array

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo100

product

string

ejemplosms

Debe ser uno de:voicesms

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

identifier

string

Requerido

Cuerpo de la solicitud
Tipo de contenido
application/json

product

string

ejemplosms

Debe ser uno de:voicesms

country

string

ejemploGB

ISO country code

interval

integer(int32)

ejemplo360

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

Debe ser uno de:1510153045603607201440

threshold

integer(int32)

ejemplo100

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo100

product

string

ejemplosms

Debe ser uno de:voicesms

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

Debe ser uno de:voicesms

country

string

ejemploGB

ISO country code

interval

integer(int32)

ejemplo360

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

Debe ser uno de:1510153045603607201440

threshold

integer(int32)

ejemplo100

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo100

product

string

ejemplosms

Debe ser uno de:voicesms

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

ejemplosms

Debe ser uno de:voicesms

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas
Tipo de contenido
application/json

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

country

string

ejemploGB

interval

integer(int32)

ejemplo60

threshold

integer(int32)

ejemplo100

product

string

ejemplosms

Debe ser uno de:voicesms

string

ejemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Requerido

A single HAL link object

href

string

Requerido

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

ejemploapplication/json

Media type hint for the target resource

name

string

ejemploresource-name

Secondary key for selecting link objects

title

string

ejemploResource Title

Human-readable title for the link

Ejemplo Respuesta

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

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

ejemplosms

Debe ser uno de:voicesms

string

Requerido

ejemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respuestas

No Content - Resource successfully deleted

Cabecera Parámetros

X-Request-Id

string(uuid)

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

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

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

Operaciones disponibles

Create rule

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Listing rules

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get rule by id

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Archive rule by id

Autenticación

Ruta Parámetros

Respuestas

Cabecera Parámetros

Update rule by id

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

AIT Protection

Operaciones disponibles

Get AIT configuration

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

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

Cabecera Parámetros

Ejemplo Respuesta

SMS Burst Protection

Operaciones disponibles

List SMS Burst Protection entries

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Create new SMS Burst Protection entity

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Get SMS Burst Protection rule by ID

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

Edit an existing SMS Burst Protection rule

Autenticación

Ruta Parámetros

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Cabecera Parámetros

Ejemplo Respuesta

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

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

Cuerpo de la solicitud
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

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