Skip to content

🛠️ Methods

🌍 countries

  • Type: () => Promise<Array<GetCountriesOne>>
  • Description: Retrieves the list of available countries.
  • docs: [ru] [en].
  • Example:
typescript
const driver = new OnlineSimDriver('APIKEY');
const getter = driver.free();

getter.countries().then((result) => {
  console.log(result);
  // Output: [{ country: 7, country_text: 'Russia' }, { country: 1, country_text: 'USA' }]
});

📱 numbers

  • Type: (country: number) => Promise<Array<GetNumbersOne>>
  • Description: Retrieves the list of available phone numbers for a specific country.
  • docs: [ru] [en]
  • Parameters:
    • country: number — The country code.
  • Example:
typescript
const driver = new OnlineSimDriver('APIKEY');
const getter = driver.free();

getter.numbers(7).then((result) => {
  console.log(result);
  // Output: [{ maxdate: '2023-01-01', number: '1234567890', country: 7, updated_at: '2023-01-01', data_humans: '1 day ago', full_number: '1234567890', country_text: 'Russia' }]
});

📨 messages

  • Type: (phone: number, page?: number) => Promise<Array<GetMessagesOne>>
  • Description: Retrieves the list of messages for a specific phone number.
  • docs: [ru] [en]
  • Parameters:
    • phone: number — The phone number.
    • page: number — Optional. The page number for pagination. Default is 1.
  • Example:
typescript
const driver = new OnlineSimDriver('APIKEY');
const getter = driver.free();

getter.messages(1234567890, 1).then((result) => {
  console.log(result);
  // Output: [{ text: 'Hello', in_number: '1234567890', my_number: 1, created_at: '2023-01-01', data_humans: '1 day ago' }]
});

Example

typescript
const driver = new OnlineSimDriver('APIKEY');
const getter = driver.free();

getter.countries().then((countries) => {
  getter.numbers(countries[0].country).then((numbers) => {
    getter.messages(numbers[0].number).then((messages) => {
      console.log(messages);
    });
  });
});

Diagram

Diagram

Released under the MIT License.