Number Insight API

The Number Insight API delivers real-time intelligence about the validity, reachability and roaming status of a phone number and tells you how to format the number correctly in your application. There are three levels of Number Insight API available: Basic, Standard and Advanced. The advanced API is available asynchronously as well as synchronously.

Effective February 4, 2027, Vonage will sunset Vonage Number Insights. To ensure uninterrupted support and to provide a more scalable and future-proof solution, we encourage you to migrate to our enhanced offering: Vonage Identity Insights API.

The Vonage Identity Insights API consolidates multiple phone number-related datasets into a single, flexible API, allowing you to request real-time information about a phone number and retrieve any combination of insights - such as number formatting, carrier details, SIM Swap and Subscriber Match - in one call.

Please review the Number Insights Transition Guide, which provides detailed guidance on API differences, required changes, and best practices for a smooth transition.

Télécharger la spécification OpenAPI

Opérations disponibles

Basic Number Insight

Provides basic number insight information about a number.

Note that this endpoint also supports POST requests.

gethttps://api.nexmo.com/ni/basic/:format

Authentification

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

Trajectoire Paramètres

format

string

Exigée

The format of the response

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

Demande de renseignements Paramètres

number

string

A single phone number that you need insight about in national or international format.

country

string

If a number does not have a country code or is uncertain, set the two-character country code. This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US. If you set country and number is already in E.164 format, country must match the country code in number.

Réponses
Type de contenu
application/json

status

integer

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.

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

status_message

string

exempleSuccess

The status description of your request.

request_id

string

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

international_format_number

string

exemple447700900000

The number in your request in international format.

national_format_number

string

exemple07700 900000

The number in your request in the format used by the country the number belongs to.

country_code

string

exempleGB

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3

string

exempleGBR

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_name

string

exempleUnited Kingdom

The full name of the country that number is registered in.

country_prefix

string

exemple44

The numeric prefix for the country that number is registered in.

Exemple Réponse

{
   "status": 0,
   "status_message": "Success",
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "international_format_number": "447700900000",
   "national_format_number": "07700 900000",
   "country_code": "GB",
   "country_code_iso3": "GBR",
   "country_name": "United Kingdom",
   "country_prefix": "44"
}

Standard Number Insight

Provides standard number insight information about a number.

Note that this endpoint also supports POST requests.

gethttps://api.nexmo.com/ni/standard/:format

Authentification

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

Trajectoire Paramètres

format

string

Exigée

The format of the response

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

Demande de renseignements Paramètres

number

string

A single phone number that you need insight about in national or international format.

country

string

cnam

boolean

Indicates if the name of the person who owns the phone number should be looked up and returned in the response. Set to true to receive phone number owner name in the response. This feature is available only for US numbers but not all US numbers are supported. It incurs an additional charge for US numbers regardless of whether any information is returned. For non-US numbers and for non-approved users, the CNAM response attributes are omitted and no additional charges are incurred.

Réponses
Type de contenu
application/json

L'un des

status

integer

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.

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

status_message

string

exempleSuccess

The status description of your request.

request_id

string

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

international_format_number

string

exemple447700900000

The number in your request in international format.

national_format_number

string

exemple07700 900000

The number in your request in the format used by the country the number belongs to.

country_code

string

exempleGB

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3

string

exempleGBR

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_name

string

exempleUnited Kingdom

The full name of the country that number is registered in.

country_prefix

string

exemple44

The numeric prefix for the country that number is registered in.

request_price

string

exemple0.04000000

The amount in EUR charged to your account.

refund_price

string

exemple0.01500000

If there is an internal lookup error, the refund_price will reflect the lookup price. If cnam is requested for a non-US number the refund_price will reflect the cnam price. If both of these conditions occur, refund_price is the sum of the lookup price and cnam price.

remaining_balance

string

exemple1.23456789

Your account balance in EUR after this request.

current_carrier

object

Information about the network number is currently connected to. While in some cases and regions it may return information for non-mobile numbers, this field is supported only for mobile numbers.

network_code

string

exemple12345

The https://en.wikipedia.org/wiki/Mobile_country_code for the carriernumber is associated with. Unreal numbers are marked asnull and the request is rejected altogether if the number is impossible according to the E.164 guidelines.

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

original_carrier

object

Information about the network number was initially connected to.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

ported

string

exemplenot_ported

If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.

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

caller_identity

object

Information about the network number is currently connected to.

caller_type

string

exempleconsumer

The value will be business if the owner of a phone number is a business. If the owner is an individual the value will be consumer. The value will be unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

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

caller_name

string

exempleJohn Smith

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

first_name

string

exempleJohn

First name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request. unknown if this information is not available.

last_name

string

exempleSmith

Last name of the person who owns the phone number if the owner is an individual. This parameter is only present if cnam had a value of true within the request. unknown if this information is not available.

caller_name

string

exempleJohn Smith

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

last_name

string

exempleSmith

first_name

string

exempleJohn

caller_type

string

exempleconsumer

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

Exemple Réponse»Standard Response

{
   "status": 0,
   "status_message": "Success",
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "international_format_number": "447700900000",
   "national_format_number": "07700 900000",
   "country_code": "GB",
   "country_code_iso3": "GBR",
   "country_name": "United Kingdom",
   "country_prefix": "44",
   "request_price": "0.04000000",
   "refund_price": "0.01500000",
   "remaining_balance": "1.23456789",
   "current_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "original_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "ported": "not_ported",
   "caller_identity": {
      "caller_type": "consumer",
      "caller_name": "John Smith",
      "first_name": "John",
      "last_name": "Smith"
   },
   "caller_name": "John Smith",
   "last_name": "Smith",
   "first_name": "John",
   "caller_type": "consumer"
}

Advanced Number Insight (async)

Provides advanced number insight number information asynchronously using the URL specified in the callback parameter. recommends asynchronous use of the Number Insight Advanced API, to avoid timeouts.

Note that this endpoint also supports POST requests.

gethttps://api.nexmo.com/ni/advanced/async/:format

Authentification

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

Trajectoire Paramètres

format

string

Exigée

The format of the response

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

Demande de renseignements Paramètres

callback

string(uriref)

The callback URL

number

string

A single phone number that you need insight about in national or international format.

country

string

cnam

boolean

string

This parameter is deprecated as we are no longer able to retrieve reliable IP data globally from carriers.

Réponses
Type de contenu
application/json

L'un des

request_id

string

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

number

string

exemple447700900000

The number in your request

remaining_balance

string

exemple1.23456789

Your account balance in EUR after this request.

request_price

string

exemple0.01500000

status

integer

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.
19	Facility Not Allowed - your request makes use of a facility that is not enabled on your account.
43, 44, 45	Live mobile lookup not returned. Not all return parameters are available.
999	Request unparseable.

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

error_text

string

exempleSuccess

The status description of your request. Note: This field is equivalent to status_message field in the other endpoints

Exemple Réponse»Async Response

{
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "number": "447700900000",
   "remaining_balance": "1.23456789",
   "request_price": "0.01500000",
   "status": 0,
   "error_text": "Success"
}

Advanced Number Insight (sync)

Provides advanced number insight information about a number synchronously, in the same way that the basic and standard endpoints do.

Vonage recommends accessing the Advanced API asynchronously using the /advanced/async endpoint, to avoid timeouts.

Note that this endpoint also supports POST requests.

gethttps://api.nexmo.com/ni/advanced/:format

Authentification

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

Trajectoire Paramètres

format

string

Exigée

The format of the response

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

Demande de renseignements Paramètres

real_time_data

boolean

[This parameter is deprecated] Real time data about the number. This is applicable to mobile numbers only.

number

string

A single phone number that you need insight about in national or international format.

country

string

cnam

boolean

string

This parameter is deprecated as we are no longer able to retrieve reliable IP data globally from carriers.

Réponses
Type de contenu
application/json

L'un des

status

integer

Exigée

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.
19	Facility Not Allowed - your request makes use of a facility that is not enabled on your account.
43, 44, 45	Live mobile lookup not returned. Not all return parameters are available.
999	Request unparseable.

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

status_message

string

Exigée

exempleSuccess

The status description of your request.

request_id

string

Exigée

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

international_format_number

string

Exigée

exemple447700900000

The number in your request in international format.

national_format_number

string

Exigée

exemple07700 900000

The number in your request in the format used by the country the number belongs to.

country_code

string

Exigée

exempleGB

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3

string

Exigée

exempleGBR

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_name

string

Exigée

exempleUnited Kingdom

The full name of the country that number is registered in.

country_prefix

string

Exigée

exemple44

The numeric prefix for the country that number is registered in.

request_price

string

exemple0.04000000

The amount in EUR charged to your account.

refund_price

string

exemple0.01500000

remaining_balance

string

exemple1.23456789

Your account balance in EUR after this request.

current_carrier

object

Information about the network number is currently connected to. While in some cases and regions it may return information for non-mobile numbers, this field is supported only for mobile numbers.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

original_carrier

object

Information about the network number was initially connected to.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

ported

string

exemplenot_ported

If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.

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

roaming

object

Information about the roaming status for number. This is applicable to mobile numbers only. If unknown, this may return a string of unknown instead of an object.

status

string

exempleroaming

Is number outside its home carrier network.

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

roaming_country_code

string

exempleUS

If number is roaming, this is the code of the country number is roaming in.

roaming_network_code

string

exemple12345

If number is roaming, this is the id of the carrier network number is roaming in.

roaming_network_name

string

exempleAcme Inc

If number is roaming, this is the name of the carrier network number is roaming in.

caller_identity

object

Information about the network number is currently connected to.

caller_type

string

exempleconsumer

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

caller_name

string

exempleJohn Smith

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

first_name

string

exempleJohn

last_name

string

exempleSmith

lookup_outcome

integer

Shows if all information about a phone number has been returned. Possible values:

Code	Text
0	Success
1	Partial success - some fields populated
2	Failed

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

lookup_outcome_message

string

exempleSuccess

Shows if all information about a phone number has been returned.

valid_number

string

exemplevalid

Does number exist. unknown means the number could not be validated. valid means the number is valid. not_valid means the number is not valid. inferred_not_valid means that the number could not be determined as valid or invalid via an external system and the best guess is that the number is invalid. This is applicable to mobile numbers only.

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

reachable

string

exemplereachable

Can you call number now. This is applicable to mobile numbers only.

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

real_time_data

object

[This parameter is deprecated] Real time data about the number

active_status

string

exempleinactive

[This parameter is deprecated. If requested it returns always inactive]. Whether the end-user's phone number is assigned to an operator's network. Can be active, inactive or null.

handset_status

string

exempleoff

[This parameter is deprecated. If requested it returns always off]. Whether the end-user's handset is reachable. Can be on if reachable or off if not reachable.

Exemple Réponse»Advanced Response (sync)

{
   "status": 0,
   "status_message": "Success",
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "international_format_number": "447700900000",
   "national_format_number": "07700 900000",
   "country_code": "GB",
   "country_code_iso3": "GBR",
   "country_name": "United Kingdom",
   "country_prefix": "44",
   "request_price": "0.04000000",
   "refund_price": "0.01500000",
   "remaining_balance": "1.23456789",
   "current_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "original_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "ported": "not_ported",
   "roaming": {
      "status": "roaming",
      "roaming_country_code": "US",
      "roaming_network_code": "12345",
      "roaming_network_name": "Acme Inc"
   },
   "caller_identity": {
      "caller_type": "consumer",
      "caller_name": "John Smith",
      "first_name": "John",
      "last_name": "Smith"
   },
   "lookup_outcome": 0,
   "lookup_outcome_message": "Success",
   "valid_number": "valid",
   "reachable": "reachable",
   "real_time_data": {
      "active_status": "inactive",
      "handset_status": "off"
   }
}

Crochets Web

Les webhooks sont une extension d'une API, mais au lieu que votre code demande des données, l'API vous envoie des données. Les données arrivent dans une requête web à votre application.

Pour en savoir plus sur les webhooks, consultez notre site documentation sur les webhooks.

Cette API peut envoyer l'un des webhooks décrits ci-dessous à l'URL que vous avez configurée. Vous devez répondre avec une réponse HTTP 200 ou 204, sinon les demandes seront relancées.

Opérations disponibles

Asynchronous response webhook

posthttps://example.com/webhooks/event

Corps de la demande
Type de contenu
application/json

status

integer

Exigée

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.
19	Facility Not Allowed - your request makes use of a facility that is not enabled on your account.
43, 44, 45	Live mobile lookup not returned. Not all return parameters are available.
999	Request unparseable.

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

status_message

string

Exigée

exempleSuccess

The status description of your request.

request_id

string

Exigée

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

international_format_number

string

Exigée

exemple447700900000

The number in your request in international format.

national_format_number

string

Exigée

exemple07700 900000

The number in your request in the format used by the country the number belongs to.

country_code

string

Exigée

exempleGB

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3

string

Exigée

exempleGBR

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_name

string

Exigée

exempleUnited Kingdom

The full name of the country that number is registered in.

country_prefix

string

Exigée

exemple44

The numeric prefix for the country that number is registered in.

request_price

string

exemple0.04000000

The amount in EUR charged to your account.

refund_price

string

exemple0.01500000

remaining_balance

string

exemple1.23456789

Your account balance in EUR after this request.

current_carrier

object

Information about the network number is currently connected to. While in some cases and regions it may return information for non-mobile numbers, this field is supported only for mobile numbers.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

original_carrier

object

Information about the network number was initially connected to.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

ported

string

exemplenot_ported

If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.

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

roaming

object

Information about the roaming status for number. This is applicable to mobile numbers only. If unknown, this may return a string of unknown instead of an object.

status

string

exempleroaming

Is number outside its home carrier network.

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

roaming_country_code

string

exempleUS

If number is roaming, this is the code of the country number is roaming in.

roaming_network_code

string

exemple12345

If number is roaming, this is the id of the carrier network number is roaming in.

roaming_network_name

string

exempleAcme Inc

If number is roaming, this is the name of the carrier network number is roaming in.

caller_identity

object

Information about the network number is currently connected to.

caller_type

string

exempleconsumer

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

caller_name

string

exempleJohn Smith

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

first_name

string

exempleJohn

last_name

string

exempleSmith

lookup_outcome

integer

Shows if all information about a phone number has been returned. Possible values:

Code	Text
0	Success
1	Partial success - some fields populated
2	Failed

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

lookup_outcome_message

string

exempleSuccess

Shows if all information about a phone number has been returned.

valid_number

string

exemplevalid

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

reachable

string

exemplereachable

Can you call number now. This is applicable to mobile numbers only.

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

Exemple Charge utile

{
   "status": 0,
   "status_message": "Success",
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "international_format_number": "447700900000",
   "national_format_number": "07700 900000",
   "country_code": "GB",
   "country_code_iso3": "GBR",
   "country_name": "United Kingdom",
   "country_prefix": "44",
   "request_price": "0.04000000",
   "refund_price": "0.01500000",
   "remaining_balance": "1.23456789",
   "current_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "original_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "ported": "not_ported",
   "roaming": {
      "status": "roaming",
      "roaming_country_code": "US",
      "roaming_network_code": "12345",
      "roaming_network_name": "Acme Inc"
   },
   "caller_identity": {
      "caller_type": "consumer",
      "caller_name": "John Smith",
      "first_name": "John",
      "last_name": "Smith"
   },
   "lookup_outcome": 0,
   "lookup_outcome_message": "Success",
   "valid_number": "valid",
   "reachable": "reachable"
}

Réponses

Asynchronous response with Unknown Roaming webhook

Contains the response to your Number Insight Advanced API request.

posthttps://example.com/webhooks/event

Corps de la demande
Type de contenu
application/json

status

integer

Exigée

Code	Text
0	Success - request accepted for delivery by .
1	Busy - you have made more requests in the last second than are permitted by your account. Please retry.
3	Invalid - your request is incomplete and missing some mandatory parameters.
4	Invalid credentials - the api_key or api_secret you supplied is either not valid or has been disabled.
5	Internal Error - the format of the recipient address is not valid.
9	Partner quota exceeded - your account does not have sufficient credit to process this request.
19	Facility Not Allowed - your request makes use of a facility that is not enabled on your account.
43, 44, 45	Live mobile lookup not returned. Not all return parameters are available.
999	Request unparseable.

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

status_message

string

Exigée

exempleSuccess

The status description of your request.

request_id

string

Exigée

Max40

exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

The unique identifier for your request. This is a alphanumeric string up to 40 characters.

international_format_number

string

Exigée

exemple447700900000

The number in your request in international format.

national_format_number

string

Exigée

exemple07700 900000

The number in your request in the format used by the country the number belongs to.

country_code

string

Exigée

exempleGB

Two character country code for number. This is in ISO 3166-1 alpha-2 format.

country_code_iso3

string

Exigée

exempleGBR

Three character country code for number. This is in ISO 3166-1 alpha-3 format.

country_name

string

Exigée

exempleUnited Kingdom

The full name of the country that number is registered in.

country_prefix

string

Exigée

exemple44

The numeric prefix for the country that number is registered in.

request_price

string

exemple0.04000000

The amount in EUR charged to your account.

refund_price

string

exemple0.01500000

remaining_balance

string

exemple1.23456789

Your account balance in EUR after this request.

current_carrier

object

Information about the network number is currently connected to. While in some cases and regions it may return information for non-mobile numbers, this field is supported only for mobile numbers.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

original_carrier

object

Information about the network number was initially connected to.

network_code

string

exemple12345

name

string

exempleAcme Inc

The full name of the carrier that number is associated with.

country

string

exempleGB

The country that number is associated with. This is in ISO 3166-1 alpha-2 format.

network_type

string

exemplemobile

The type of network that number is associated with.

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

ported

string

exemplenot_ported

If the user has changed carrier for number. The assumed status means that the information supplier has replied to the request but has not said explicitly that the number is ported.

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

roaming

string

exempleunknown

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

caller_identity

object

Information about the network number is currently connected to.

caller_type

string

exempleconsumer

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

caller_name

string

exempleJohn Smith

Full name of the person or business who owns the phone number. unknown if this information is not available. This parameter is only present if cnam had a value of true within the request.

first_name

string

exempleJohn

last_name

string

exempleSmith

lookup_outcome

integer

Shows if all information about a phone number has been returned. Possible values:

Code	Text
0	Success
1	Partial success - some fields populated
2	Failed

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

lookup_outcome_message

string

exempleSuccess

Shows if all information about a phone number has been returned.

valid_number

string

exemplevalid

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

reachable

string

exemplereachable

Can you call number now. This is applicable to mobile numbers only.

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

Exemple Charge utile

{
   "status": 0,
   "status_message": "Success",
   "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "international_format_number": "447700900000",
   "national_format_number": "07700 900000",
   "country_code": "GB",
   "country_code_iso3": "GBR",
   "country_name": "United Kingdom",
   "country_prefix": "44",
   "request_price": "0.04000000",
   "refund_price": "0.01500000",
   "remaining_balance": "1.23456789",
   "current_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "original_carrier": {
      "network_code": "12345",
      "name": "Acme Inc",
      "country": "GB",
      "network_type": "mobile"
   },
   "ported": "not_ported",
   "roaming": "unknown",
   "caller_identity": {
      "caller_type": "consumer",
      "caller_name": "John Smith",
      "first_name": "John",
      "last_name": "Smith"
   },
   "lookup_outcome": 0,
   "lookup_outcome_message": "Success",
   "valid_number": "valid",
   "reachable": "reachable"
}

Number Insight API

Opérations disponibles

Basic Number Insight

Authentification

Trajectoire Paramètres

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Standard Number Insight

Authentification

Trajectoire Paramètres

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse»Standard Response

Advanced Number Insight (async)

Authentification

Trajectoire Paramètres

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse»Async Response

Advanced Number Insight (sync)

Authentification

Trajectoire Paramètres

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse»Advanced Response (sync)

Crochets Web

Opérations disponibles

Asynchronous response webhook

Corps de la demande Type de contenuapplication/json

Exemple Charge utile

Réponses

Asynchronous response with Unknown Roaming webhook

Corps de la demande Type de contenuapplication/json

Exemple Charge utile

Réponses

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json