-
Notifications
You must be signed in to change notification settings - Fork 181
Vonage JWT
Vonage JWT • Docs
Documentation / Vonage JWT
Enum representing the type of caller for a phone number.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
BUSINESS |
"business" |
The value will be "business" if the owner of a phone number is a business. | number-insights/lib/enums/CallerType.ts:13 |
CONSUMER |
"consumer" |
The value will be "consumer" if the owner of a phone number is an individual. | number-insights/lib/enums/CallerType.ts:18 |
UNKNOWN |
"unknown" |
The value will be "unknown" if the information about the caller type is not available. | number-insights/lib/enums/CallerType.ts:8 |
Enum representing the outcomes of a lookup operation.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
FAILED |
2 |
The lookup operation failed. | number-insights/lib/enums/LookupOutcome.ts:18 |
PARTIAL_SUCCESS |
1 |
The lookup operation partially succeeded. | number-insights/lib/enums/LookupOutcome.ts:13 |
SUCCESS |
0 |
The lookup operation was successful. | number-insights/lib/enums/LookupOutcome.ts:8 |
Enum representing the type of network associated with a phone number.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
LANDLINE |
"landline" |
The phone number is associated with a landline network. | number-insights/lib/enums/NetworkType.ts:13 |
LANDLINE_PREMIUM |
"landline_premium" |
The phone number is associated with a premium landline network. | number-insights/lib/enums/NetworkType.ts:18 |
LANDLINE_TOLLFREE |
"landline_tollfree" |
The phone number is associated with a toll-free landline network. | number-insights/lib/enums/NetworkType.ts:23 |
MOBILE |
"mobile" |
The phone number is associated with a mobile network. | number-insights/lib/enums/NetworkType.ts:8 |
PAGER |
"pager" |
The phone number is associated with a pager network. | number-insights/lib/enums/NetworkType.ts:38 |
UNKNOWN |
"unknown" |
The type of network associated with the phone number is unknown. | number-insights/lib/enums/NetworkType.ts:33 |
VIRTUAL |
"virtual" |
The phone number is associated with a virtual network. | number-insights/lib/enums/NetworkType.ts:28 |
Enum representing the reachability status of a phone number.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
ABSENT |
"absent" |
The phone number's owner is absent. | number-insights/lib/enums/Reachable.ts:23 |
BAD_NUMBER |
"bad_number" |
The phone number is invalid or a bad number. | number-insights/lib/enums/Reachable.ts:28 |
BLACKLISTED |
"blacklisted" |
The phone number is blacklisted. | number-insights/lib/enums/Reachable.ts:33 |
REACHABLE |
"reachable" |
The phone number is reachable. | number-insights/lib/enums/Reachable.ts:13 |
UNDELIVERABLE |
"undeliverable" |
The phone number is undeliverable. | number-insights/lib/enums/Reachable.ts:18 |
UNKNOWN |
"unknown" |
The reachability status is unknown. | number-insights/lib/enums/Reachable.ts:8 |
Enum representing the validity status of a phone number.
| Enumeration Member | Value | Description | Defined in |
|---|---|---|---|
INFERRED |
"inferred" |
The validity of the phone number is inferred. | number-insights/lib/enums/ValidNumber.ts:23 |
INFERRED_NOT_VALID |
"inferred_not_valid" |
The inferred validity of the phone number is not valid. | number-insights/lib/enums/ValidNumber.ts:28 |
NOT_VALID |
"not_valid" |
The phone number is not valid. | number-insights/lib/enums/ValidNumber.ts:18 |
UNKNOWN |
"unknown" |
The validity status is unknown. | number-insights/lib/enums/ValidNumber.ts:8 |
VALID |
"valid" |
The phone number is valid. | number-insights/lib/enums/ValidNumber.ts:13 |
Client for the Vonage Number Insights API.
Create a standalone Number Insight client
import { NumberInsights } from '@vonage/numberInsight';
const numberInsightClient = new NumberInsights({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
});Create an Number Insight client from the Vonage client
import { Vonage } from '@vonage/server-client';
const vonage = new Vonage({
apiKey: VONAGE_API_KEY,
apiSecret: VONAGE_API_SECRET
});
const numberInsightClient = vonage.numberInsight;new NumberInsights(credentials, options?): NumberInsightsCreates a new instance of the Client.
• credentials: AuthInterface | AuthParams
The authentication credentials or an authentication instance.
• options?: ConfigParams
Optional configuration settings for the client.
server-client/dist/lib/client.d.ts:35
protected auth: AuthInterface;The authentication instance responsible for generating authentication headers and query parameters.
server-client/dist/lib/client.d.ts:24
protected optional authType: AuthenticationType;The type of authentication used for the client's requests.
server-client/dist/lib/client.d.ts:20
protected config: ConfigParams;Configuration settings for the client, including default hosts for various services and other request settings.
server-client/dist/lib/client.d.ts:28
static transformers: object;Static property containing utility transformers.
camelCaseObjectKeys: PartialTransformFunction;kebabCaseObjectKeys: PartialTransformFunction;omit: (keys, obj) => TransformedObject;• keys: string[]
• obj: ObjectToTransform
snakeCaseObjectKeys: PartialTransformFunction;server-client/dist/lib/client.d.ts:11
addAuthenticationToRequest(request): Promise<VetchOptions>Adds the appropriate authentication headers or parameters to the request based on the authentication type.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addAuthenticationToRequest
server-client/dist/lib/client.d.ts:43
protected addBasicAuthToRequest(request): Promise<VetchOptions>Adds basic authentication headers to the request.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
server-client/dist/lib/client.d.ts:71
protected addJWTToRequest(request): Promise<VetchOptions>Adds a JWT to the request.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
server-client/dist/lib/client.d.ts:64
protected addQueryKeySecretToRequest(request): Promise<VetchOptions>Adds API key and secret to the request.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequest
server-client/dist/lib/client.d.ts:57
protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>Adds API key and secret to the request body.
• request: VetchOptions
The request options to which authentication needs to be added.
Promise<VetchOptions>
- The request options with the added authentication.
Client.addQueryKeySecretToRequestBody
server-client/dist/lib/client.d.ts:50
advancedLookup(phoneNumber, options?): Promise<AdvancedResponse>Perform an advanced number lookup operation.
• phoneNumber: string
The phone number to perform the lookup for.
• options?: AdvancedLookupOptions
Additional options for the lookup.
Promise<AdvancedResponse>
A promise that resolves to the advanced lookup response.
const lookup = await numberInsightsClient.advancedLookup('15555551212');
console.log(`Ths number is ${lookup.valid_number}`);number-insights/lib/number-insights.ts:54
asyncAdvancedLookup(
phoneNumber,
callback,
options?): Promise<AsyncAdvancedResponse>Perform an asynchronous advanced number lookup operation.
• phoneNumber: string
The phone number to perform the lookup for.
• callback: string
The callback URL for receiving the async lookup response.
• options?: StandardLookupOptions
Additional options for the lookup.
Promise<AsyncAdvancedResponse>
A promise that resolves to the async advanced lookup response.
const lookup = await numberInsightsClient.asyncAdvancedLookup(
'15555551212',
'https://example.com/number-insights',
);
console.log(`The request ID is ${lookup.request_id}`);Lookup with the CNAME option:
const lookup = await numberInsightsClient.asyncAdvancedLookup(
'15555551212',
'https://example.com/number-insights',
{ cname: true },
);
console.log(`The request ID is ${lookup.request_id}`);number-insights/lib/number-insights.ts:94
basicLookup(phoneNumber, options?): Promise<BasicResponse>Perform a basic number lookup operation.
• phoneNumber: string
The phone number to perform the lookup for.
• options?: BasicLookupOptions
Additional options for the lookup.
Promise<BasicResponse>
A promise that resolves to the basic lookup response.
const lookup = await numberInsightsClient.basicLookup(
'15555551212',
);
console.log(`The request ID is ${lookup.request_id}`);Lookup with the country option:
const lookup = await numberInsightsClient.basicLookup(
'15555551212',
{ country: 'US' },
);
console.log(`The request ID is ${lookup.request_id}`);number-insights/lib/number-insights.ts:132
getConfig(): ConfigParamsserver-client/dist/lib/client.d.ts:36
protected parseResponse<T>(request, response): Promise<VetchResponse<T>>Parses the response based on its content type.
• T
The expected type of the parsed response data.
• request: VetchOptions
The request options.
• response: Response
The raw response from the request.
Promise<VetchResponse<T>>
- The parsed response.
server-client/dist/lib/client.d.ts:168
protected prepareBody(request): undefined | stringPrepares the body for the request based on the content type.
• request: VetchOptions
The request options.
undefined | string
- The prepared request body as a string or undefined.
server-client/dist/lib/client.d.ts:158
protected prepareRequest(request): Promise<VetchOptions>Prepares the request with necessary headers, authentication, and query parameters.
• request: VetchOptions
The initial request options.
Promise<VetchOptions>
- The modified request options.
server-client/dist/lib/client.d.ts:151
sendDeleteRequest<T>(url): Promise<VetchResponse<T>>Sends a DELETE request to the specified URL.
• T
• url: string
The URL endpoint for the DELETE request.
Promise<VetchResponse<T>>
- The response from the DELETE request.
server-client/dist/lib/client.d.ts:78
sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request with form data to the specified URL.
• T
• url: string
The URL endpoint for the POST request.
• payload?: Record<string, undefined | string>
Optional payload containing form data to send with the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/lib/client.d.ts:86
sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>Sends a GET request to the specified URL with optional query parameters.
• T
• url: string
The URL endpoint for the GET request.
• queryParams?
Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.
Promise<VetchResponse<T>>
- The response from the GET request.
server-client/dist/lib/client.d.ts:94
sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PATCH request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PATCH request.
• payload?
Optional payload to be sent as the body of the PATCH request.
Promise<VetchResponse<T>>
- The response from the PATCH request.
server-client/dist/lib/client.d.ts:104
sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a POST request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the POST request.
• payload?
Optional payload to be sent as the body of the POST request.
Promise<VetchResponse<T>>
- The response from the POST request.
server-client/dist/lib/client.d.ts:114
sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>Sends a PUT request to the specified URL with an optional payload.
• T
• url: string
The URL endpoint for the PUT request.
• payload?
Optional payload to be sent as the body of the PUT request.
Promise<VetchResponse<T>>
- The response from the PUT request.
server-client/dist/lib/client.d.ts:124
sendRequest<T>(request): Promise<VetchResponse<T>>Sends a request adding necessary headers, handling authentication, and parsing the response.
• T
• request: VetchOptions
The options defining the request, including URL, method, headers, and data.
Promise<VetchResponse<T>>
- The parsed response from the request.
server-client/dist/lib/client.d.ts:144
sendRequestWithData<T>(
method,
url,
payload?): Promise<VetchResponse<T>>Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.
• T
• method: POST | PUT | PATCH
The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).
• url: string
The URL endpoint for the request.
• payload?
Optional payload to be sent as the body of the request, JSON-encoded.
Promise<VetchResponse<T>>
- The response from the request.
server-client/dist/lib/client.d.ts:135
standardLookup(phoneNumber, options?): Promise<StandardResponse>Perform a standard number lookup operation.
• phoneNumber: string
The phone number to perform the lookup for.
• options?: StandardLookupOptions
Additional options for the lookup.
Promise<StandardResponse>
A promise that resolves to the standard lookup response.
const lookup = await numberInsightsClient.standardLookup(
'15555551212',
);
console.log(`The request ID is ${lookup.request_id}`);Lookup with the cname option:
const lookup = await numberInsightsClient.standardLookup(
'15555551212',
{ cname: true },
);
console.log(`The request ID is ${lookup.request_id}`);number-insights/lib/number-insights.ts:169
type AdvancedLookupOptions: StandardLookupOptions & object;Interface representing advanced lookup options for a phone number lookup operation.
optional real_time_data: boolean;Indicates whether real-time data should be included in the lookup.
If true, real-time data is included; otherwise, it's not included.
number-insights/lib/types/AdvancedLookupOptions.ts:6
type AdvancedResponse: StandardResponse & object;Type representing an advanced response from a phone number lookup operation.
lookup_outcome: LookupOutcome;The outcome of the lookup operation, represented by a LookupOutcome enum value.
lookup_outcome_message: string;A message describing the outcome of the lookup operation.
reachable: Reachable;The reachability status of the phone number, represented by a Reachable enum value.
real_time_data: RealTimeDataResponse;Real-time data related to the phone number.
roaming: RoamingDataResponse | string;Information about the roaming status of the phone number.
valid_number: ValidNumber;The validity status of the phone number, represented by a ValidNumber enum value.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/AdvancedResponse.ts:18
type AsyncAdvancedLookupOptions: StandardLookupOptions & object;Interface representing asynchronous advanced lookup options for a phone number lookup operation.
callback: string;The callback URL to which the lookup response will be sent asynchronously.
number-insights/lib/types/AsyncAdvancedLookupOptions.ts:6
type AsyncAdvancedResponse: object;Type representing an asynchronous advanced response from a phone number lookup operation. This response may include additional details about the request and its status.
error_text: string;Any error text or message associated with the response.
number: string;The phone number associated with the response.
remaining_balance: string;Your account balance in EUR after this request.
request_id: string;The unique identifier for the request.
request_price: string;The amount in EUR charged to your account for this request.
status: number;The status code of the response.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:9
type BasicLookupOptions: object;Basic lookup options for a phone number lookup operation.
optional country: string;The two-character country code for the phone number's country.
number-insights/lib/types/BasicLookupOptions.ts:4
type BasicResponse: object;Type representing a basic response from a phone number lookup operation.
country_code: string;The two-character country code for the phone number.
country_code_iso3: string;The three-character country code for the phone number.
country_name: string;The full name of the country that the phone number is registered in.
country_prefix: string;The numeric prefix for the country that the phone number is registered in.
international_format_number: string;The phone number in international format.
national_format_number: string;The phone number in the format used by the country.
request_id: string;The unique identifier for the request.
status: number;The status code of the response.
status_message: string;The status message of the response.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/BasicResponse.ts:8
type CallerIdentityResponse: object;Type representing the identity of a caller.
caller_name: string;The caller's name.
caller_type: CallerType;The type of the caller, either "business," "consumer," or "unknown."
first_name: string;The caller's first name.
last_name: string;The caller's last name.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/CallerIdentityResponse.ts:10
type CarrierInfoResponse: object;Type representing carrier information.
country: string;The country in which the carrier operates.
name: string;The full name of the carrier.
network_code: string;The network code associated with the carrier.
network_type: NetworkType;The type of network associated with the carrier.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/CarrierInforResponse.ts:10
type NumberInsightsResponse<T>: VetchResponse<T>;Interface representing a response from a number insights operation.
This extends the VetchResponse<T> interface.
• T
number-insights/lib/types/NumberInsightsResponse.ts:7
type RealTimeDataResponse: object;Type representing real-time data related to a phone number.
active_status: string;handset_status: string;Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/RealTimeDataResponse.ts:8
type RoamingDataResponse: object;Type representing information about the roaming status of a phone number.
roaming_country_code: string;roaming_network_code: string;roaming_network_name: string;status: string;Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.
number-insights/lib/types/Responses/RoamingDataResponse.ts:8
type StandardLookupOptions: BasicLookupOptions & object;Interface representing standard lookup options for a phone number lookup operation.
optional cname: boolean;Indicates whether caller name (CNAME) information should be included in the lookup.
If true, CNAME information is included; otherwise, it's not included.
number-insights/lib/types/StandardLookupOptions.ts:6
type StandardResponse: BasicResponse & object;Type representing a standard response from a phone number lookup operation. This response includes various details such as pricing, carrier information, porting status, and caller identity.
caller_identity: CallerIdentityResponse;Information about the caller's identity.
caller_name: string;Full name of the person or business who owns the phone number.
caller_type: CallerType;The type of caller, either "business," "consumer," or "unknown."
country_code: string;The two-character country code for the phone number.
country_code_iso3: string;The three-character country code for the phone number.
country_name: string;The full name of the country that the phone number is registered in.
country_prefix: string;The numeric prefix for the country that the phone number is registered in.
current_carrier: CarrierInfoResponse;Information about the current carrier of the phone number.
first_name: string;First name of the person who owns the phone number.
international_format_number: string;The phone number in international format.
last_name: string;Last name of the person who owns the phone number.
national_format_number: string;The phone number in the format used by the country.
original_carrier: CarrierInfoResponse;Information about the original carrier of the phone number.
ported: string;Porting status of the phone number.
refund_price: string;The refund amount in EUR, reflecting lookup and CNAM pricing.
remaining_balance: string;Your account balance in EUR after this request.
request_id: string;The unique identifier for the request.
request_price: string;The price charged for the request in EUR.
status: number;The status code of the response.
status_message: string;The status message of the response.
Vonage API's will return information using snake_case. This represents the
pure response before the client will transform the keys into camelCase.