Introduction to the Telgoo5 REST API Navigate to XML API

You can use REST API to create your own customized applications and processes. Almost every aspect of Vcare system can be accessed with these sets of REST API.

API Transaction sets

An API transaction set consists of an JSON request, which you submit to the Vcare system and JSON response which is returned to you as a result of JSON request. Sample JSON request and responses for all the available REST API are included in this document.

Getting started to use Vcare REST API

In order to begin using Vcare REST API, you need to obtain the following as each REST API transaction contains a session section, and the following information is used to authenticate the transaction.

  • User Name

    A unique user name is associated with the MVNO/OSS partner.

  • Token/Password

    This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose.

  • PIN:

    This is generated by Vcare to provide an additional layer of security in the Interim API.

    • Above information for test environment and production environment can be obtained from your respective account manager.

  • AgentID

    This is the Telgoo5 API user ID of the agent who is sending the API request. This is just like any other Telgoo5 user ID. You can setup a regular Telgoo5 user just for the API transactions.

  • Agent Password

    This is the password for the Agent ID mentioned above. This is configuration level field. If you have set the permissions for the Agent ID for the requirement of the password in API transactions then you will need to pass the Agent Password in all the REST API transaction, else if you have set the permissions to password not required then you do not need to pass the Agent Password in the REST API.

    • Telgoo5 terms and definitions

  • Customer ID

    This is unique auto generated customer account number in Telgoo5. This is assigned to the subscriber as soon as the account is created in Telgoo5.

  • Enrollment ID

    This is unique auto generated number in Telgoo5. This is assigned to the subscriber's application as soon as the application is started in Telgoo5.

  • MDN

    This is a telephone number which is associated with the subscriber's account.

  • ESN

    This is a CDMA device's electronic serial number.

  • SIM

    This is a SIM number.

  • PlanServiceType

    These are the NLAD service types for the corresponding plans. V for Voice, BD for Broadband, BV for Bundled Voice, BBD for Bounded Bundled Data, BVBD for Bundled Voice and Broadband.

  • Carrier Abbreviation

    TMB is for T-Mobile. SPR is for Sprint. VER is for Verizon. ATT for AT&T. TAL is for Telispire

  • Company ID

    A unique number ID assigned to the MVNO in Telgoo5.

  • Eligibility Number

    This is the number of the qualifying eligibility program.

  • Created Date

    This is the lifeline activation date for the lifeline orders.

    • For any further questions and any queries you may have please reach out to helpdesk@vcaremail.com and we will be more then happy to assist you.