Shelex / free-otp-api

puppeteer-as-an-api for parsing otp codes or auth tokens

Home Page:https://otp.shelex.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

otp.shelex.dev

Get list of phone numbers and specific sms for specific phone number to use in tests which involve a lot of otp codes.

Description

API

  • get list of countries available:
        GET https://otp.shelex.dev/api/countries
  • get list of phone numbers per country:
        GET https://otp.shelex.dev/api/list/{{country}}
  • get otp code:
        GET https://otp.shelex.dev/api/{{country}}/{{phone}}?match={{substring}}&ago={{ago}}
    
    • country is a country name - USA, UK, Ukraine, Canada, Moldova, Spain... full list in docs in "available values" section. Basically is a union of all supported countries across services.
    • phone - is a phone number as it is specified in url, 10-13 digits, without "+" sign
    • match (optional) - substring to look for in the sms
    • ago (optional, 30s by default) - the max time ago to look for specific sms, units are s - secons, m - minutes, h - hours, for example: 10s, 5m, 1h, etc. Will be converted to timestamp.
    • since (optional) - instead of ago string exact timestamp could be specified.
    • source (optional) - specify service which provide phone number, uses receive-sms-free.cc by default.
    • recursively queries the first page of latest phone number messages and matches sms by match substring or ago/since query parameter, refreshing page every 5 seconds.
    • returns sms that matches provided inputs and tries to parse otp code..

About

puppeteer-as-an-api for parsing otp codes or auth tokens

https://otp.shelex.dev


Languages

Language:TypeScript 97.5%Language:HTML 1.9%Language:CSS 0.7%