Web SMS Login
网页版登录
Web SMS Login

PingMe Verification Code Helper
API Documentation

Bulk Purchase of Phone Numbers for Receiving Verification Codes


The activation steps are as follows:

1. Please fill out the form below and click “Apply for API Activation”. Our customer support team will receive your application.
2. Our customer support team will verify if you meet the criteria for the API bulk phpne number purchase.
3. Once you are confirmed as an eligible user, your API URL will become active.
4. If you have any questions, please feel free to contact our customer support at [email protected].

Activate yout API Now

PingMe Verification Code Helper
API Documentation

Get App List

method:GET
headers:
accept:"application/json"
x-app-key: Provided when enabling API permissions

After executing the following command, obtain the app name to be used as a parameter in the Get Phone Number API

curl -H 'Accept: application/json' -H 'x-app-key: key' -H 'Content-Type: application/json' -d '{"userId":"xxx"}' https://api.pingme.tel/thirdparty/getAppList

Get Phone Number

https://api.pingme.tel/thirdparty/lockNumber
method:POST
headers:
accept:"application/json"
x-app-key: Provided when enabling API permissions
Parameter:
userId: Provided when enabling API permissions
app: The App that needs to receive verification codes
number: Empty indicates retrieving a new one, while a value indicates it has been used before
countryCode：US by default, also supports GB
Successfully locked a phone number, returned:
{
  "retcode": 0,
  "retmsg": "success",
  "result": {
    "number": 16510000000,
    "price": 0.5
  }
}
Failed to lock a phone number, returned:
{
  "retcode": Error code, (100000 Internal error, 100004 Missing parameter, 300002 Insufficient balance, 500000 No available numbers, 500001 Too many numbers locked, 500002 Number does not exist or has expired)
  "retmsg": "",
  "result": {}
}
Example:
curl -X POST -H "Content-Type:application/json" -H "accept: application/json" -H 'X-app-key:xxx' -d '{"userId":"xxx","app":"jd","number":""}' 'https://api.pingme.tel/thirdparty/lockNumber'
Returned:
{
  "retcode": 0,
  "retmsg": "success",
  "result": {
    "number": "16510000000"
  }
}

Subscribe to Phone Number

https://api.pingme.tel/thirdparty/subNumber
method: POST
header:
accept: "application/json"
x-app-key: Provided when enabling API permissions
Parameter:
userId: userId cannot be empty
app: Specified app cannot be empty
number: The phone number to subscribe to cannot be empty
Returned:
response.type = "application/json"
response.status=403 (Request failed, no permission)
response.status=200
Successfully subscribed to a phone number, returned:
{
   "retcode":0,
   "retmsg":"success",
   "result":{
      
   }
}
Failed to subscribe a phone number, returned:
{
   "retcode":"Error code",(100000 Internal error ，100004 Missing parameter，300002 Insufficient balance)
   "retmsg":"",
   "result":{
      
   }
}
Example:
curl -X POST -H "Content-Type:application/json" -H "accept: application/json" -H 'X-app-key:xxx' -d '{"userId":"xxx","app":"jd","number":"1xxxxxxxxxx"}' 'https://api.pingme.tel/thirdparty/subNumber'
Returned:
{
   "retcode":0,
   "retmsg":"success",
   "result":{
      
   }
}

Unsubscribe Phone Number

https://api.pingme.tel/thirdparty/unSubNumber
method:POST
header:
accept:"application/json"
x-app-key: Provided when enabling API permissions
Parameter:
userId: userId cannot be empty
app: Specified app cannot be empty
number: The phone number that needs to be unsubscribed cannot be empty
Returned:
response.type = "application/json"
response.status=403 (Request failed, no permission)
response.status=200
Successfully unsubscribed a phone number, returned:
{
   "retcode":0,
   "retmsg":"success",
   "result":{
      
   }
}
Failed to unsubscribe a phone number, returned:
{
   "retcode":"Error code",(100000 Internal error, 100004 Missing parameter)
   "retmsg":"",
   "result":{
      
   }
}
Example:
curl -X POST -H "Content-Type:application/json" -H "accept: application/json" -H 'X-app-key:xxx' -d '{"userId":"xxx","app":"jd","number":"1xxxxxxxxxx"}' 'https://api.pingme.tel/thirdparty/unSubNumber'
Returned:
{
   "retcode":0,
   "retmsg":"success",
   "result":{
      
   }
}

Get the List of Non-Expired Verification Code Phone Numbers

https://api.pingme.tel/thirdparty/getNumberList
method:GET
header:
accept:"application/json"
x-app-key: Provided when enabling API permissions
Parameter:
userId: userId cannot be empty
app: If empty, return all non-expired phone numbers; if not empty, get the phone number for the specified app
Returned:
response.type="application/json"
response.status=403 (Request failed, no permission)
response.status=200
List retrieved successfully, returned:
phone：Phone number
subStatus：0 Not subscribed，1 Subscribed
nextPaymentDate：Expiry date
subRent：New subscription monthly fee
codeRate：SMS rate
monthRent：Current monthly fee（when subStatus=1）

{
   "retcode":0,
   "retmsg":"success",
   "result":{
      "numbers":[
         {
            "phone":"XX",
            "nextPaymentDate":"XX",
            "subStatus":"XX",
            "subRent":"XX",
            "app":"XX",
            "monthRent":"XX",
            "name":"XX",
            "telCode":"XX",
            "codeRate":"XX"
         }
      ]
   }
}
Failed, returned:
{
   "retcode":Error code,(100000 Internal error ，100004 Missing parameter)
   "retmsg":"",
   "result":{
   }
}
Example:
curl -H "Content-Type:application/json" -H "accept: application/json" -H 'X-app-key:xxx' 'https://api.pingme.tel/thirdparty/getNumberList?userId=xxx&app='
Returned:
{
   "retcode":0,
   "retmsg":"success",
   "result":{
      "numbers":[
         {
            "phone":"168151020115",
            "nextPaymentDate":"2021-11-22 (Expiry Date)",
            "subStatus":0,
            "subRent":"$0.5 / Month",
            "app":"jd",
            "monthRent":"",
            "name":"JD",
            "telCode":"1",
            "codeRate":"$0.2 / SMS"
         }
      ]
   }
}

SMS Callback Requires Pre-Configuring the Callback URL

method:POST
header:
Content-Type:application/json
Parameters to be received:
userId
app
from  The phone number of the app provider (it may not be a phone number, but a string)
to    Receiver's phone number
text  SMS content
time  Date and time
Example:
{
  "app": "jd",
  "from": "14160000000",
  "to": "16470000000",
  "userId": "xxx",
  "text": "[jd] code is 5611",
  "time": "2021-03-25T03:17:06.050Z"
}

API Application Form

Please fill out the form below for API activation

8 + 7 =

PingMe Logo<br />

Streamline Your Verification Process Today!

Buy your own number now for hassle-free SMS verification and secure your online accounts instantly.

Get My Number
PingMe Logo<br />

Streamline Your Verification Process Today!

Buy your own number now for verification
and secure your accounts instantly.

Get My Number