API docs by Redocly

API Documentation (3.0)

Download OpenAPI specification:Download

Welcome to PVADeals - API Docs

Explore our technical documentation. Our library of endpoints gives you everything you need to build your non-voip white-label solution.

 

Environment  BASE URL
PROD https://prod-v3.pvadeals.com/v3

 

Security :- An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.Example: Authorization: 123 

Common Error codes

Messages HTTP Status Code Reason
Authorization Header Required 401 Authorization header is missing while making http request.
Invalid Api Key 404 Authorization header value is not correct. 
Api Key is blocked 403 Due to system abuse or user is blocked by admin.
API under maintenance 503 Temporary site is down due to maintenance activity

Note :-  By using our API, you agree with our terms and services. 

  1. Privacy Term Policy :- https://pvadeals.com/privacy-policy/
  2. Terms & Condition :- https://pvadeals.com/terms-and-conditions/
  3. Refund Policy :- https://pvadeals.com/refund-policy/

PVADeals-API

User Info

Fetch information about the current user using the supplied API key.

Authorizations:
authorizationauthorization
header Parameters
authorization
required
string

Responses

Website Services

Get list of available website names.

Authorizations:
authorizationauthorization
header Parameters
authorization
required
string

Responses

Number Info

Get every detail of phone number such as type of number, service name, status, start/end date, charges, country, sms code, auto renew, etc.

Authorizations:
authorizationauthorization
path Parameters
id
required
any
header Parameters
authorization
required
string

Responses

All Number History

Get the history of purchased phone numbers.

Authorizations:
authorizationauthorization
query Parameters
filter
string
after
string
first
number
header Parameters
authorization
required
string

Responses

SMS Codes

Retrieve the latest SMS received for the service request.

Authorizations:
authorizationauthorization
query Parameters
filter
string
after
string
first
number
header Parameters
authorization
required
string

Responses

Buy Number

Buy non-voip number of any type LTR, STR, or STR Premium

Authorizations:
authorizationauthorization
header Parameters
authorization
required
string
Request Body schema: application/json
required
Array of objects (ServicePurchaseInputType)
isLtr
boolean
isPremium
boolean
object
carrier
string
Enum: "UK" "USA"

Responses

Request samples

Content type
application/json
{
  • "services": [
    ],
  • "isLtr": true,
  • "isPremium": true,
  • "state": {
    },
  • "carrier": "UK"
}

Reuse Number

Reuse number with following STATUS. Completed, Timeout, Flagged.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string

Responses

Flag Number

Cancel purchased number and get refund, maximum 10 number flags per 24 hours.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string

Responses

Send SMS

Use this command to send an SMS to sender. The maximum limit is 160 characters, including numbers, characters, space, and symbols.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
requestId
required
string
smsText
required
string

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "smsText": "string"
}

Activate LTR Number

ACTIVATE the phone number before using it for the verification.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string

Responses

LTR Number Status

Know the ONLINE/OFFLINE status of the number by passing this command.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string

Responses

LTR Auto Renew

Extend the duration of the number beyond 30 days; it will automatically extend the number as long as you keep it ON. Maintain sufficient funds in your account to keep the number.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string

Responses

Call Forward

Choose voice verification on any website, and input your US phone number to receive a verification call. This command only works for All Websites and does not support other individual services.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
requestId
required
string
forwardedNumber
required
string

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "forwardedNumber": "string"
}

Activate Bulk LTR Numbers

Activate multiple phone numbers from this command. e.g., Choose 25 numbers and activate all of them at once.

Authorizations:
authorizationauthorization
path Parameters
id
required
string
header Parameters
authorization
required
string
Request Body schema: application/json
requestIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "requestIds": [
    ]
}

Bulk LTR Activation List

Get the list of phone numbers that are processed for activation in bulk.

Authorizations:
authorizationauthorization
header Parameters
authorization
required
string

Responses