Skip to content

CreditsApi.md

Latest commit

 

History

History
56 lines (35 loc) · 1.25 KB

CreditsApi.md

File metadata and controls

56 lines (35 loc) · 1.25 KB

TheSmsWorksApi.CreditsApi

All URIs are relative to https://api.thesmsworks.co.uk/v1

Method HTTP request Description
creditsBalanceGet GET /credits/balance

creditsBalanceGet

CreditsResponse creditsBalanceGet()

Returns the number of credits currently available on the account

Example

import TheSmsWorksApi from 'the_sms_works_api';
let defaultClient = TheSmsWorksApi.ApiClient.instance;
// Configure API key authorization: JWT
let JWT = defaultClient.authentications['JWT'];
JWT.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//JWT.apiKeyPrefix = 'Token';

let apiInstance = new TheSmsWorksApi.CreditsApi();
apiInstance.creditsBalanceGet((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

This endpoint does not need any parameter.

Return type

CreditsResponse

Authorization

JWT

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json;charset=UTF-8