Fraud Defender API

Versão 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.

Baixar a especificação OpenAPI

Traffic Rules

Operations to manage traffic rules.

Operações disponíveis

Create rule

Create a new fraud rule based on phone number prefixes.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

Obrigatório

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Obrigatório

Max15

exemplo44

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

Obrigatório

exemploMy custom prefix rule

Human readable reason

action

string

Obrigatório

exemploblock

Deve ser uma das seguintes opções:blockallow

status

string

exemploactive

Deve ser uma das seguintes opções:activearchivedall

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

rule operation success

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Max15

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchivedall

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Consulta Parâmetros

product

string

exemplosms

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

Deve ser uma das seguintes opções:voicesms

prefix

string

Max15

exemplo44

phone prefix filter

reason

string

exemploMy custom prefix rule

reason filter

action

string

exemploblock

action filter

Deve ser uma das seguintes opções:blockallow

rule_type

string

rule type filter (allow, block)

Deve ser uma das seguintes opções:allowblock

status

string

exemploactive

filter rules by status (active, archived, all)

Deve ser uma das seguintes opções:activearchivedall

show_default_rules

boolean

Padrãotrue

defines whether to display default rules or not

show_custom_rules

boolean

Padrãotrue

show custom rules flag

page_size

integer

exemplo10

Page size in Integer format

page

integer

Mín.1

exemplo2

Page number in Integer format

sort

string

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

Deve ser uma das seguintes opções:productprefixtraffic

order

string

Padrãodesc

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

Deve ser uma das seguintes opções:ascdesc

Respostas
Tipo de conteúdo
application/json

rule listing success

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

page

object

page_size

integer

exemplo10

Items per page

page

integer

Mín.1

exemplo2

Page Offset

total_pages

integer

Mín.1

exemplo100

Number of pages in the entire result set

total_items

integer

exemplo100

Number of items in the entire result set

_embedded

object

rules

array

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Max15

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchivedall

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas
Tipo de conteúdo
application/json

rule operation success

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Max15

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchivedall

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas

No Content - Resource successfully deleted

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corpo da solicitação
Tipo de conteúdo
application/json

reason

string

Obrigatório

exemploMy custom prefix rule

Human readable reason

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

rule operation success

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemplotest-id

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

prefix

string

Max15

exemplo44

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

exemplofrom

Deve ser uma das seguintes opções:fromto

traffic_direction

string

Padrãooutbound

exemplooutbound

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

action

string

exemploblock

Deve ser uma das seguintes opções:blockallow

reason

string

exemploMy custom prefix rule

Human readable reason

permission

string

exemploedit

Deve ser uma das seguintes opções:viewedit

status

string

exemploactive

Deve ser uma das seguintes opções:activearchivedall

created_timestamp

string

exemplo2022-12-09T18:19:26

updated_timestamp

string

exemplo2022-11-09T18:19:26

archived_timestamp

string

exemplo2022-10-09T18:19:26

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Operações disponíveis

Get AIT configuration

Retrieve the current AIT protection configuration for a given product.

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Padrãosms

product type

Deve ser uma das seguintes opções:sms

Respostas
Tipo de conteúdo
application/json

AIT protection config response

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

data

object

protection_enabled

boolean

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

Padrãosms

product type

Deve ser uma das seguintes opções:sms

Corpo da solicitação
Tipo de conteúdo
application/json

data

object

protection_enabled

boolean

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

AIT protection config response

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

data

object

protection_enabled

boolean

exemplotrue

used to turn on/off AIT protection

default_protection_level

string

exemplostandard

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

Deve ser uma das seguintes opções:highstandardnone

protection_level_per_country

array

array of specific per-country AIT protection level configurations

country

string

Obrigatório

exemploUS

country code in ISO 3166-1 Alpha-2 standard

protection_level

string

Obrigatório

exemplohigh

AIT protection level

Deve ser uma das seguintes opções:highstandardnone

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Operações disponíveis

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Consulta Parâmetros

page

integer

Mín.1

exemplo2

Page number in Integer format

page_size

integer

exemplo10

Page size in Integer format

Respostas
Tipo de conteúdo
application/json

Successful operation

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

page

object

page_size

integer

exemplo10

Items per page

page

integer

Mín.1

exemplo2

Page Offset

total_pages

integer

Mín.1

exemplo100

Number of pages in the entire result set

total_items

integer

exemplo100

Number of items in the entire result set

_embedded

object

entries

array

string

exemploabcdef01-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 disponíveis:

AD,AE,AF,AG,AI,AL,AM,AO,AQ,AR,AT,AU,AW,AZ,BA,BB,BD,BE,BF,BG,BH,BI,BJ,BM,BN,BO,BR,BS,BT,BW,BY,BZ,CA,CD,CF,CG,CH,CI,CK,CL,CM,CN,CO,CR,CU,CV,CW,CY,CZ,DE,DJ,DK,DM,DO,DZ,EC,EE,EG,EH,ER,ES,ET,FI,FJ,FK,FM,FO,FR,GA,GB,GD,GE,GF,GG,GH,GI,GL,GM,GN,GP,GQ,GR,GT,GW,GY,HK,HN,HR,HT,HU,ID,IE,IL,IM,IN,IO,IQ,IR,IS,IT,JE,JM,JO,JP,KE,KG,KH,KI,KM,KN,KP,KR,KW,KY,KZ,LA,LB,LC,LI,LK,LR,LS,LT,LU,LV,LY,MA,MC,MD,ME,MG,MH,MK,ML,MM,MN,MO,MQ,MR,MS,MT,MU,MV,MW,MX,MY,MZ,NA,NC,NE,NG,NI,NL,NO,NP,NR,NU,NZ,OM,PA,PE,PF,PG,PH,PK,PL,PM,PR,PS,PT,PW,PY,QA,RE,RO,RS,RU,RW,SA,SB,SC,SD,SE,SG,SH,SI,SK,SL,SM,SN,SO,SR,SS,ST,SV,SX,SY,SZ,TC,TD,TG,TH,TJ,TK,TL,TM,TN,TO,TR,TT,TV,TW,TZ,UA,UG,US,UY,UZ,VA,VC,VE,VG,VN,VU,WF,WS,XK,YE,ZA,ZM,ZW

block_value

integer

exemplo1

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

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

destination_countries

array

Obrigatório

Valores disponíveis:

block_value

integer

Obrigatório

exemplo1

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

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

Successful operation

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemploabcdef01-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 disponíveis:

block_value

integer

exemplo1

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

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas
Tipo de conteúdo
application/json

Successful operation

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemploabcdef01-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 disponíveis:

block_value

integer

exemplo1

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

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Corpo da solicitação
Tipo de conteúdo
application/json

destination_countries

array

Obrigatório

Valores disponíveis:

block_value

integer

Obrigatório

exemplo1

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

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

Successful operation

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

string

exemploabcdef01-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 disponíveis:

block_value

integer

exemplo1

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

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas

No Content - Resource successfully deleted

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

Operações disponíveis

List custom fraud alerts

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

identifier

string

Obrigatório

Deve ser uma das seguintes opções:SMSVOICE

Consulta Parâmetros

page_size

integer

exemplo10

Page size in Integer format

page

integer

Mín.1

exemplo2

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

Respostas
Tipo de conteúdo
application/json

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

page

object

page_size

integer

exemplo10

Items per page

page

integer

Mín.1

exemplo2

Page Offset

total_pages

integer

Mín.1

exemplo100

Number of pages in the entire result set

total_items

integer

exemplo100

Number of items in the entire result set

_embedded

object

entries

array

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo100

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

identifier

string

Obrigatório

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

country

string

exemploGB

ISO country code

interval

integer(int32)

exemplo360

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

Deve ser uma das seguintes opções:1510153045603607201440

threshold

integer(int32)

exemplo100

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo100

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

country

string

exemploGB

ISO country code

interval

integer(int32)

exemplo360

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

Deve ser uma das seguintes opções:1510153045603607201440

threshold

integer(int32)

exemplo100

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo100

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

exemplosms

Deve ser uma das seguintes opções:voicesms

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas
Tipo de conteúdo
application/json

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

country

string

exemploGB

interval

integer(int32)

exemplo60

threshold

integer(int32)

exemplo100

product

string

exemplosms

Deve ser uma das seguintes opções:voicesms

string

exemploabcdef01-2345-6789-abcd-ef0123456789

_links

object

HAL Links object

self

object

Obrigatório

A single HAL link object

href

string

Obrigatório

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

The URL for the resource

templated

boolean

Indicates if the href is a URI template

type

string

exemploapplication/json

Media type hint for the target resource

name

string

exemploresource-name

Secondary key for selecting link objects

title

string

exemploResource Title

Human-readable title for the link

Exemplo Resposta

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

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

product

string

Obrigatório

exemplosms

Deve ser uma das seguintes opções:voicesms

string

Obrigatório

exemploabcdef01-2345-6789-abcd-ef0123456789

Rule ID in UUID format

Respostas

No Content - Resource successfully deleted

Cabeçalho Parâmetros

X-Request-Id

string(uuid)

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

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

Erros

A seguir, apresentamos uma lista não exaustiva de códigos de erro que podem ocorrer durante o uso desta API.

Esses códigos são adicionais aos que constam em nosso site códigos de erro genéricos.

Código	Informações
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

Operações disponíveis

Create rule

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Listing rules

Autenticação

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Get rule by id

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Archive rule by id

Autenticação

Caminho Parâmetros

Respostas

Cabeçalho Parâmetros

Update rule by id

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

AIT Protection

Operações disponíveis

Get AIT configuration

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Create or update AIT configuration

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

SMS Burst Protection

Operações disponíveis

List SMS Burst Protection entries

Autenticação

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Create new SMS Burst Protection entity

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Get SMS Burst Protection rule by ID

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Edit an existing SMS Burst Protection rule

Autenticação

Caminho Parâmetros

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Cabeçalho Parâmetros

Exemplo Resposta

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json