tfnr_ap_is v1.0.0

tfnr_ap_is

TfnrApIs - JavaScript client for tfnr_ap_is

Introduction This document describes the new SMS/800 Toll-Free Number (TFN) Registry APIs exposed to all Responsible Organization (Resp Org) users requiring to access the SMS/800 TFN Registry via APIs. The SMS/800 TFN Registry Application Program Interfaces (APIs) follow a standard RESTful model using the Richardson Maturity Model level 1 approach with the standard HTTP verbs @GET, @POST, @PUT, @DELETE to represent the CRUD operations against the defined resources. The PUT verb is used for full and partial updates, POST for creates, GET for reads, and DELETE for deletes. # Authentication SMS/800 Toll-Free Number (TFN) Registry APIs requires access tokens to invoke business API end points. The access token can be obtained in two different ways, using the industry standard OAuth 2.0 password grant flow or by invoking an /session/open api. # OAuth 2.0 TFNR APIS support industry standard OAuth 2.0 authentication and authorization for accessing the APIs. The API server supports password grant for obtaining the access tokens which are valid for 60 minutes and refresh grant for refreshing/using the access tokens beyond the initial 60 minutes. The following endpoints can be used for invoking the OAuth 2.0 functionalities. Production: https://api-tfnregistry.somos.com/token Sandbox: https://api-devp-tfnregistry.somos.com/token To use OAuth 2.0 password grant flow, you will be required to provide four values, user-name, password, clientKey and clienkSecret. You can get the clientKey and clientSecret by invoking the /session/open api. You are required to invoke this only once to obtain the keys. Never share your secret keys. Keep them guarded and secure. Access Tokens have an expiration period of 60 minutes and needs to be refreshed using the refresh grant type of OAuth2.0 standards. /token api can be used for both password and refresh grants. To obtain the accesstoken for the first time, the following information needs to be posted as part of the body json grant_type=password&username={logonid}&password={pass} json grant_type=refresh_token&refresh_token={retoken} and the header should include the following information json Authorization : Basic (base64 encoded clientKey:clientSecret) both the password grant and refresh grant returns the following json body json { \"scope\":\"default\", \"token_type\":\"Bearer\", \"expires_in\":3600, \"refresh_token\":\"ca5a51f18b2edf4eaa9e4b871e42b58a\", \"access_token\":\"f2c66f146278aaaf6513b585b5b68d1d\" } # Invoking APIS It is IMPORTANT to note that, at this time SMS/800 Toll-Free Number (TFN) Registry APIs only supports one active session for any given user name for all channels (WBA, TFNR Application and Enhanced Platform). If the user tries to open multiple sessions, the previous session will be automatically terminated. Also, at this time APIs do not support parallel requests due to the limitation of the existing system. So, users should only send one request at a time and wait till the response is returned by the server. If the backed server returns a 202 with a RequestId, the user should NOT submit another request till the user does the polling and obtain the response of the previous request. # Polling Some of the TFNR APIs when invoked has the possibility of exceeding the defined timeout for a synchronous call, and so there is a possibility that the apis will return a HTTP 202 code with a RequestId that a client will use to poll for a response. This is common for search and reserve APIs and users are responsible to capture the RequestId and use the APIs provided to do the polling and obtain the actual response of the api invocation. In certain cases when the users do the polling, they might get a 202 again if the request is still being processed, in this case the user is required to wait for few seconds and do the polling till he gets the final response back from the server. # Throttling Users will be throttled at the RespOrg Level with a rate limit of 12000 requests/minute per RespOrg in Production and 3000 requests/minute per RespOrg in Developer Portal environment.

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: v1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.somos.com/contact-us

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install tfnr_ap_is --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/tfnr_ap_is then install it via:

    npm install YOUR_USERNAME/tfnr_ap_is --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TfnrApIs = require('tfnr_ap_is');

var api = new TfnrApIs.BulkAdministration_Api()

var authorization = "authorization_example"; // {String} Bearer access_token


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.bulkCount(authorization, callback);

Documentation for API Endpoints

All URIs are relative to https://api-devp-tfnregistry.somos.com/v1/ip

Documentation for Models

• TfnrApIs.Announcement
• TfnrApIs.Aos
• TfnrApIs.ApprStat
• TfnrApIs.ArrayOfString
• TfnrApIs.AuditStatusNumberRequest
• TfnrApIs.AuditStatusNumberResponse
• TfnrApIs.BlkLst
• TfnrApIs.BlkResp
• TfnrApIs.BoolYN
• TfnrApIs.BoolYNExt
• TfnrApIs.Cmd
• TfnrApIs.Cons
• TfnrApIs.CountBulkResponse
• TfnrApIs.CprSectName
• TfnrApIs.CritInd
• TfnrApIs.CustRecCompPart
• TfnrApIs.CustRecStat
• TfnrApIs.CustomerRecordQueryResponse
• TfnrApIs.CustomerRecordQueryResponseEffDtTmList
• TfnrApIs.CustomerUnlockRequest
• TfnrApIs.CustomerUnlockResponse
• TfnrApIs.DelLstRequest
• TfnrApIs.DelLstResponse
• TfnrApIs.DeleteBulkRequest
• TfnrApIs.DeleteBulkResponse
• TfnrApIs.DeleteNumberRequest
• TfnrApIs.DeleteNumberResponse
• TfnrApIs.DeletePointerRequest
• TfnrApIs.DeletePointerResponse
• TfnrApIs.DestNums
• TfnrApIs.DisconnectCustomerRequest
• TfnrApIs.DisconnectCustomerResponse
• TfnrApIs.DisconnectPointerRequest
• TfnrApIs.DisconnectPointerResponse
• TfnrApIs.DisconnectUpdatePointerRequest
• TfnrApIs.DisconnectUpdatePointerResponse
• TfnrApIs.EnableBlocking
• TfnrApIs.Err
• TfnrApIs.ErrList
• TfnrApIs.ErrLvl
• TfnrApIs.HoldDueDt
• TfnrApIs.Lbl
• TfnrApIs.LblType
• TfnrApIs.ListBulkResponse
• TfnrApIs.LstEffDtTms
• TfnrApIs.Nodes
• TfnrApIs.Npa
• TfnrApIs.NumAllocInd
• TfnrApIs.NumberLimitsQueryResponse
• TfnrApIs.NumberQueryResponse
• TfnrApIs.NumberSearchRequest
• TfnrApIs.NumberSearchReserveRequest
• TfnrApIs.NumberSearchReserveResponse
• TfnrApIs.NumberSearchResponse
• TfnrApIs.NumberSpareRequest
• TfnrApIs.NumberSpareResponse
• TfnrApIs.NumberUpdateRequest
• TfnrApIs.NumberUpdateResponse
• TfnrApIs.OauthResponse
• TfnrApIs.OneClickActivateRequest
• TfnrApIs.OneClickActivateResponse
• TfnrApIs.PasswordForgetRequest
• TfnrApIs.PasswordForgetResponse
• TfnrApIs.PasswordResetRequest
• TfnrApIs.PasswordResetResponse
• TfnrApIs.PasswordUpdateRequest
• TfnrApIs.PasswordUpdateResponse
• TfnrApIs.PermNDUB
• TfnrApIs.PermNV
• TfnrApIs.PermNVDUB
• TfnrApIs.PermNVU
• TfnrApIs.PermNY
• TfnrApIs.PermRecord
• TfnrApIs.Permissions
• TfnrApIs.PointerCopyRequest
• TfnrApIs.PointerCopyResponse
• TfnrApIs.PointerCopyUpdateRequest
• TfnrApIs.PointerCopyUpdateResponse
• TfnrApIs.PointerCreateRequest
• TfnrApIs.PointerCreateResponse
• TfnrApIs.PointerRetrieveResponse
• TfnrApIs.PointerTransferRequest
• TfnrApIs.PointerTransferResponse
• TfnrApIs.PointerTransferUpdateRequest
• TfnrApIs.PointerTransferUpdateResponse
• TfnrApIs.PointerUpdateRequest
• TfnrApIs.PointerUpdateResponse
• TfnrApIs.RecStat
• TfnrApIs.RecordCopyRequest
• TfnrApIs.RecordCopyResponse
• TfnrApIs.RecordCopyUpdateRequest
• TfnrApIs.RecordCopyUpdateResponse
• TfnrApIs.RecordCreateRequest
• TfnrApIs.RecordCreateResponse
• TfnrApIs.RecordDeleteRequest
• TfnrApIs.RecordDeleteResponse
• TfnrApIs.RecordDisconnectUpdateRequest
• TfnrApIs.RecordDisconnectUpdateResponse
• TfnrApIs.RecordRetrieveResponse
• TfnrApIs.RecordTransferRequest
• TfnrApIs.RecordTransferResponse
• TfnrApIs.RecordTransferUpdateRequest
• TfnrApIs.RecordTransferUpdateResponse
• TfnrApIs.RecordUpdateRequest
• TfnrApIs.RecordUpdateResponse
• TfnrApIs.Referral
• TfnrApIs.ReqSntFrom
• TfnrApIs.ReqStatus
• TfnrApIs.ReqType
• TfnrApIs.RespOrgList
• TfnrApIs.SCPQueryNumberResponse
• TfnrApIs.SCPResendRequest
• TfnrApIs.SCPResendResponse
• TfnrApIs.ScpRecStat
• TfnrApIs.ScpRecs
• TfnrApIs.ScpRecsQuery
• TfnrApIs.SessionCloseResponse
• TfnrApIs.SessionOpenRequest
• TfnrApIs.SessionOpenResponse
• TfnrApIs.Stat
• TfnrApIs.States
• TfnrApIs.Status
• TfnrApIs.TRQResult
• TfnrApIs.TempList
• TfnrApIs.TemplateListResponse
• TfnrApIs.TemplateRecordQueryResponse
• TfnrApIs.TimeZone
• TfnrApIs.TimeoutResponse
• TfnrApIs.TroubleNumberQueryResponse

Documentation for Authorization

All endpoints do not require authorization.