@(Help documentation)
Name | Value | Description |
---|---|---|
Domain | http://api.fastpva.com | |
Agreement | HTTP | |
Method | GET |
Example of the request API return (error codes are only 1 and -1, data is a successful return value or error message)
{"code":1,"data":{"apikey":"***********************"}}
{"code":-1,"data":"Wrong password"}
Please go to User Center => User Information to view apikey, if you need to change, click the update button
Route:
/pvapublic/project/list
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
page | Page | yes |
limit | Number of bars per page | yes |
keyword | Keyword ssearch | no |
channel | Project channel(value = all), no channel 6 project by default | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/project/list?page=[page]&limit=[limit]&keyword=[keyword]&apikey=[apikey]
http://api.fastpva.com/pvapublic/project/list?page=[page]&limit=[limit]&keyword=[keyword]&channel=all&apikey=[apikey]
Return to an example:
{"code":1,"data":[{"_id":"5cea527821407f5e6b7ff934","cnname":"Telegram","enname":"Telegram Indonesia","sellingPrice":50,"myPid":2000}]}
{"code":-1,"data":"Error message"}
Return data field resolution
Argument name | Describe |
---|---|
_id | - |
enname | EN Name |
sellingPrice | Price RMB(CNY) units (penny) |
countriesSellingPricePrices | Price RMB(CNY) units (penny) |
myPid | Project ID |
apikey | Personal Center => User Information View apikey |
Route:
/pvapublic/project/count
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
keyword | Keyword ssearch | no |
Example of a request:
http://api.fastpva.com/pvapublic/project/count?apikey=[apikey]
Return to an example:
{"code":1,"data":300}
{"code":-1,"data":"Error message"}
Route:
/pvapublic/sms/getNumber
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
myPid | Project ID | yes |
number | Specify Number | no |
locale | International domain name abbreviation (used when project name is not country) | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/getNumber?myPid=[myPid]&number=[number]&locale=[locale]&apikey=[apikey]
Return to an example:
{"code":1,"data":{"number":"85591740503","orderId":"5ceac209e4fa76106b64ba97"}}
{"code":-1,"data":"Number acquisition failed"}
Return data field resolution
Argument name | Describe |
---|---|
orderId | Get the order ID for the number |
number | Number |
apikey | Personal Center => User Information View apikey |
Route:
/pvapublic/sms/getCode
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
orderId | Get the order ID for the number | yes |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/getCode?orderId=[orderId]&apikey=[apikey]
Return to an example:
{"code":1,"data":{"code":"56032","content":"Telegram code 56032","number":"85770937307"}}
{"code":-1,"data":{"number":"85770937307"}}
Return data field resolution
Argument name | Describe |
---|---|
code | Verification code |
content | Text message content |
number | Number |
apikey | Personal Center => User Information View apikey |
Route:
/pvapublic/sms/releaseNumber
Release 10 seconds after acquiring number
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
orderId | Order ID returned by the Get number |
yes |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/releaseNumber?orderId=[orderId]&apikey=[apikey]
Return to an example:
{"code":1,"data":"Number released"}
{"code":-1,"data":"Number release failed"}
Route:
/pvapublic/sms/shieldNumber
Join the blacklist only if Number is unavailable or if the verification code is not available.
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
orderId | Order ID returned by the Get number |
yes |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/shieldNumber?orderId=[orderId]&apikey=[apikey]
Return to an example:
{"code":1,"data":"Number is blacklisted"}
{"code":-1,"data":"Number is blacklisted failed"}
Route:
/pvapublic/sms/order/list
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
page | Page | yes |
limit | Number of bars per page | yes |
orderId | Order ID | no |
number | Number | no |
startTime | Start time | no |
endTime | End time | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/order/list?page=[page]&limit=[limit]&orderId=[orderId]&number=[number]&startTime=[startTime]&endTime=[endTime]&apikey=[apikey]
Return to an example:
{"code":1,"data":[{"_id":"5ceb576ee4fa76106b64ba98","number":"85770937307","numberStatus":"released","smsStatus":"received","projectInfo":{"cnname":"Telegram","enname":"Telegram","sellingPrice":50,"myPid":2000},"createdAt":"2022-05-27T03:20:14.653Z","updatedAt":"2022-05-27T03:25:34.761Z","code":"56032","content":"Telegram code 56032"}]}
{"code":-1,"data":"Error message"}
Return data field resolution
Argument name | Describe |
---|---|
_id | Order ID |
code | Verification code |
content | Text message content |
number | Number |
numberStatus | NumberState |
smsStatus | SMS status |
projectInfo.enname | EN Name |
projectInfo.sellingPrice | Price RMB(CNY) units (penny) |
projectInfo.myPid | project id |
createdAt | Creation time |
updatedAt | Updatetimed |
apikey | Personal Center => User Information View apikey |
Route:
/pvapublic/sms/order/count
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
orderId | Order ID | no |
number | Number | no |
startTime | Start time | no |
endTime | End time | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/sms/order/count?orderId=[orderId]&number=[number]&startTime=[startTime]&endTime=[endTime]&apikey=[apikey]
Return to an example:
{"code":1,"data":1}
{"code":-1,"data":"Error message"}
Route:
/pvapublic/recharge/list
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
page | Page | yes |
limit | Number of bars per page | yes |
orderId | Recharge Order ID | no |
status | State”all” “paid” “unpaid” | no |
startTime | Start time | no |
endTime | End time | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/recharge/list?page=[page]&limit=[limit]&orderId=[orderId]&status=[status]&startTime=[startTime]&endTime=[endTime]&apikey=[apikey]
Return to an example:
{"code":1,"data":[{"status":"unpaid","_id":"5cea4aaa3bda3147bca812d7","amount":100,"payment":"alipay","createdAt":"2022-05-26T08:13:30.297Z","updatedAt":"2022-05-26T08:13:30.501Z","orderAmt":93}]}
{"code":-1,"data":"Error message"}
Return data field resolution
Argument name | Describe |
---|---|
_id | Order ID |
status | Payment status |
amount | Amount of order RMB(CNY) units (penny) |
orderAmt | Actual amount paid RMB(CNY) units (penny) |
payment | Payment method |
createdAt | Creation time |
updatedAt | Updatetimed |
apikey | Personal Center => User Information View apikey |
Route:
/pvapublic/recharge/count
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
orderId | Recharge Order ID | no |
status | State”all” “paid” “unpaid” | no |
startTime | Start time | no |
endTime | End time | no |
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/recharge/count?orderId=[orderId]&status=[status]&startTime=[startTime]&endTime=[endTime]&apikey=[apikey]
Return to an example:
{"code":1,"data":1}
{"code":-1,"data":"Error message"}
Route:
/pvapublic/user/info
Method:GET
Request parameters:
Argument name | Describe | Necessary |
---|---|---|
apikey | Personal Center => User Information View apikey | yes |
Example of a request:
http://api.fastpva.com/pvapublic/user/info?apikey=[apikey]
Return to an example:
{"code":1,"data":{"balance":1500,"_id":"5cdabasfsdfa5fe12sd149608e0","username":"test","mobile":"11212808012","email":"[email protected]","role":{"_id":"5cd1c1b3b183bsa70460b4e","name":"Normal users","access":"normal"},"tg":""}}
{"code":-1,"data":"Error message"}
Return data field resolution
Argument name | Describe |
---|---|
_id | User ID |
username | Username |
mobile | Mobile |
balance | Balance USD) units (penny) |
tg | tg |