| 1 |
CheckServiceAvailability |
Check the Zip code for services. |
Verify if the services are provided by the MVNO on the given Zipcode or not. |
Returns if the services are available on the given zip code or not. Returns if the given zip code is listed as Tribal or Non-tribal in Vcare. Returns if the last 4 digits of the SSN will be required or complete SSN will be required |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 2 |
getProgramIncomeList |
Get the list of eligibility programs. |
To get the list of eligibility programs for lifeline service in the given zipcode. |
Returns the list of all the eligibility programs which are available in the given zip code along with the maximum income requirement for the number of people in the household. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 3 |
GetPlanService |
Returns the available plan list on the basis of state and service availability on the basis of zip code. |
To get the list of all the plans available on the given zip code on the basis of other validations required in the request. |
Returns the list of the plans along with the plan name, Plan Ids, Plan Prices, and the amount of talk, text and data available on the plan. For lifeline plans it also returns the NLAD service type. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 4 |
DuplicateCheck |
Checks for the duplicate active service. |
To verify if the lifeline applicant is duplicate in your database with any other active subscribers or not. |
In response, if it shows DUPLICATE; it means that the subscriber is exact duplicate in the system. If it returns HOUSEHOLD then it means only the address is duplicate and you will need to pass the IEH flag in createcustomer API to override Household duplicate. If it returns SUCCESS in response then that means there is no duplicate |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 5 |
NladEtcVerify |
NLAD etcCheck |
This API directly calls NLAD check API and returns the direct response from NLAD. |
SUBSCRIBER_NOT_FOUND (Expect the exact response from NLAD) |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 6 |
NladVerify |
NLAD verify |
This API directly calls NLAD verify API and returns the direct response from NLAD. |
SUBSCRIBER_NOT_FOUND (Expect the exact response from NLAD) |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 7 |
CheckEligibilityNumbers |
Checks duplicate on the eligibility number. |
To verify the duplicity on the basis of the applicant's eligibility number of the qualifying program. |
Returns SUCCESS if there is no duplicate. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 8 |
DeviceLookup |
Check availability of the ESN/SIM in Telgoo5 inventory. |
Get the device details on the basis of ESN/SIM. |
Returns the status of the SIM/ESN, if the given SIM/ESN is assigned to the Master agent/Distributor/Retailer also returns the status of the SIM/ESN along with the Model and the selling price of the SIM/ESN where applicable. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 9 |
IMEILookup |
Check availability of the IMEI/GSM Device in Telgoo5 inventory. |
Get the IMEI/GSM Device details on the basis of IMEI/GSM Device. |
Returns the status of the IMEI/GSM device, if the given IMEI/GSM device is assigned to the Master agent/Distributor/Retailer of the agent who is making the API call or it is assigned to the agent itself or not. If the IMEI/GSM device is not assigned to the agent or its master/distributor/retailer then the API call will fail. The API also returns the status of the IMEI/GSM device along with the Model and the selling price of the IMEI/GSM device where applicable |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 10 |
CreateCustomer |
Create new lifeline customer. |
This API directly calls NLAD check API and returns the direct response from NLAD. |
This API creates a lifeline customer in Telgoo5 on the basis of the parameter passed in the request. If a lifeline customer is successfully created in Telgoo5 on the basis of this API then in response you get Enrollment Id, Customer ID, MDN and other details associated with MDN if applicable. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 11 |
CreateCustomerPrepaid |
Create prepaid order. |
To create a prepaid customer order. |
This API creates a prepaid customer in Telgoo5 on the basis of the information passed in request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 12 |
FirstCallActivation |
Changes the Telgoo5 status of a new subscriber to Active. |
To set the lifeline activation date and set the status of the account as Active for the first time enrolled subscriber on the basis of the first valid usage. |
After we call this API, it will check weather subscriber is in Dispatched status or not. If we find the subscriber in the dispatched status, system will check if the valid usage is found on the MDN or not, if the valid usage is found then this API proceeds to Activate the account. Also if the Telephone number is hotlined at carrier then it will also unhotline the line. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 13 |
GetCustomerInfo |
Returns subscriber information |
To get the information from the subscriber's account. |
Returns all the information associated with subscriber's account on the basis of customer id, enrollment id or telephone number. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 14 |
AddNotes |
Add notes on account. |
To add a note on subscriber's account. |
It creates a note on customer account. Expect a success response along with the last insert note id. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 15 |
GetPredecideNote |
Reassign Inventory. |
To reassign inventory from one agent to another. |
This API will reassign the inventory from the current agent to the new agent which is passed in the request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 16 |
Hotline |
Hotline the MDN. |
To Hotline the MDN on carrier so that calls can be redirected Hotline number. |
This API is used to Hotline the MDN on carrier so that calls can be redirected Hotline number but it does not change the account status of VCare account, it only changes the status at carrier level. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 17 |
RemoveHotline |
Remove Hotline from the MDN. |
To remove hotline from the MDN and set the status to ACTIVE at carrier level. |
This API is used to remove hotline from the MDN and it does not change the account status of VCare account, it only changes the status to ACTIVE at carrier level. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 18 |
SwapESN |
Change ESN/SIM |
To swap/change the ESN/SIM on subscriber's account. |
ESN/SIM should be changed with new ESN/SIM which is passed in the request on subscriber's account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 19 |
SwapMDN |
Change MDN |
To swap/change subscriber's telephone number. |
This API changes the MDN and returns a response with new MDN/Telephone number. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 20 |
ChangeDevice |
Change/Swap GSM Device. |
To change/swap GSM device on subscriber's account. |
This API changes/swaps a GSM device on the subscriber's account i.e. it replaces the old device with the new device passed in the request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 21 |
ChangeAddress |
To change/update subscriber's address. |
This API changes/updates the address in Telgoo5. |
API will change the subscriber's address. For the lifeline subscribers it does the Melissa Validations and Duplicate check and also updates the address in NLAD. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 22 |
AddHouseHold |
Add IEH form. |
To add the IEH worksheet on the subscriber's account. |
This API is used to add the IEH worksheet on the subscriber's account where the address is duplicate in NLAD. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 23 |
GetPlansList |
The available plan list |
The available plan list |
The list of the available plans for the change plan on customer's account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 24 |
GetPuk |
Returns MSL and PUK. |
To get the PUK number or MSL code for the ESN/SIM.. |
Returns the PUK/MSL code for the ESN/SIM./td>
| For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 25 |
ChangePlan |
Change the plan. |
To change the plan of the existing subscriber's in Telgoo5. |
This API will change the subscriber's plan in Telgoo5 and at carrier level. This API will also send an update to NLAD for the lifeline subscriber's if there is a change in the NLAD plan service type. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 26 |
GetDenomination |
Returns the available Add-on/topups. |
To get the available topup/Add-on. |
This API will return all the topups/Add-on available for the subscriber to purchase. This API will return the Plan id, carrier code, plan name of the topup/Add-on. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 27 |
AddBalance |
Add topup/Add-on on the subscriber's account. |
To add the topup/Add-on. |
This API will add a topup/Add-on on subscriber's account on the basis of the plan id passed in the request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 28 |
GetInactiveReasons |
Inactive reasons list. |
To get the list of the reason to deactivate a subscriber's account. |
This API returns the list of all available reasons for the subscriber deactivation. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 29 |
UpdateAccountStatus |
Update account status of a subscriber. |
To update Telgoo5 account status of the subscriber. |
This will allow you to suspend/restore and deactivate a subscriber's account. Deactivating subscriber using this API will remove the subscriber from NLAD as well as carrier. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 30 |
AddEquipment |
Equipment Purchase |
To take the payment and place an order for equipment purchase. |
This API will create an equipment purchase order in inventory and will return invoice number for the payment. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 31 |
Payment |
Take a payment and to refund. |
Take a payment via debit/credit card. |
This API is used to take the payment and applies the payment on the subscriber's account according to the INVOICE TYPE ID required in the request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 32 |
AddBalanceWithPayment |
Take a payment and add topup/Add-on. |
To take a payment via debit/credit card and apply Add-on/topup. |
This API is used to take the payment and applies the payment on the subscriber's account and also applies the topup/Add-on on the basis of the plan id passed in the request. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 33 |
BillPay |
Take a bill payment. |
To make the payment against the Billed invoice in the account. |
Returns the receipt number against the payment for billed invoice on the account of subscriber. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 34 |
SetAutoPay |
Activates the autopay. |
To activate the autopay functionality on the subscriber's account. |
Activates the autopay on subscriber's account and returns an acknowledgement message as SUCCESS. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 35 |
CancelAutoPay |
Deactivate autopay. |
To cancel an active auto pay on the subscriber's account. |
Returns a confirmation of cancelled auto pay on customer's account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 36 |
GetTaxDetails |
Returns tax break up. |
To get the tax amount for the given amount according to the zipcode. |
Returns the tax break up according to the zipcode for the given amount. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 37 |
AddBalanceWithInvoice |
Add balance and create invoice. |
One can apply Add-on/Toup and generate an invoice for the payments made outisde vcare system. |
Returns the invoice and receipt for the payment and at the same time also adds the balance or the plan for which the payment was made on the account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 38 |
ApplyCredit |
Add credit on the account. |
To create a credit invoice and apply credit on the subscriber's account. |
Returns the invoice/receipt number for credit applied on customer's account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 39 |
InvoicePaymentType |
Get the invoice category types. |
To get the invoice category types and invoice transaction types. |
Returns the Invoice type , Invoice details, payment method details according to the submitted invoice payment type ID. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 40 |
CreateInvoice |
Create an Invoice. |
To create an Invoice on the subscriber's account without adding balance. |
Returns the invoice number for created INVOICE on the customer account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 41 |
VoidInvoice |
Void an invoice. |
To void an invoice on the subscriber's account. |
Returns SUCESS after invoice is voided on the subscriber's account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 42 |
GetInvoiceDetails |
Get details of the invoices. |
To get the details of the invoices which have been created on the customer's account. |
Returns the customer ID, invoice number, invoice type, payment type, balance, invoice amount, transaction ID, due date, tax amount, created by and payment status. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 43 |
AddWallet |
Add/remove amount from customer's wallet. |
To debit/credit amount from the customer's wallet. |
Returns the transaction ID of the added amount in subscriber account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 44 |
ValidatePin |
This api is used to validate a PIN |
To verify the given pin is valid or not. |
Returns the response if a given PIN is a VALID PIN/USED PIN/NVALID PIN. This is only applicable if PINs are generated by Telgoo5 PIN management system. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 45 |
RedeemPin |
This api is used to redeem a PIN |
To redeem a Telgoo5 generated PIN on a subscriber's account. |
Returns the a SUCESS message if the PIN was applied successfully and also returns the plan which was applied on the account. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 46 |
AddInventory |
Add Inventory |
To add inventory in stock in Telgoo5. |
This API will add the inventory item in stock in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 47 |
AddAndActivate |
Add and activate inventory |
To add and assign inventory to agent in Telgoo5. |
This API add the inventory in Telgoo5 and activates it at carrier level and also assigns the inventory to agent. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 48 |
AddAndAssignNonActivate |
Add not provisioned inventory. |
To add and assign inventory to agent in Telgoo5 without activating at carrier level. |
This API add the inventory in Telgoo5 assigns the inventory to agent without activating it. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 49 |
AddPreActivated |
Add pre-activated inventory. |
To add and assign inventory to agent which was activated at carrier level outside Telgoo5. |
This API adds the inventory in Telgoo5 assigns the inventory to agent. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 50 |
GetMakeModel |
Get list of Make and Models. |
To get the list of the make and models available to be added in Telgoo5. |
This API will return the list of the make and models which have been configured in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 51 |
AddDevice |
Add GSM device. |
To Add and assign GSM device. |
This API is used to add a GSM device in inventory and at the same time assigns it to the agent. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 52 |
DropshipShipment |
Full fill Dropship order. |
To assign ESN/SIM and MDN to dropship order. |
This API assigns ESN/SIM and MDN to the dropship order. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 53 |
UpdateInventory |
Update inventory. |
To update the uploaded sim/esn/device details in inventory. |
This API can update the Carrier, modelid, msl,po, vendor, box, wprice, sprice, notes, activationfee details. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 54 |
InventoryModel |
Add/update make and model. |
To add new make and model. |
This API configures the new make and model of the device in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 55 |
InventoryStatusChange |
Change the status of inventory. |
To change the status of the ESN/SIM. |
This API is used to change the status of ESN/SIM in the inventory type either of BAD,FREE, REMOVED,USED. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 56 |
UpdateCarrier |
Update carrier. |
To update the carrier of the ESN/SIM loaded in the inventory. |
This API changes the carrier of the ESN/SIM which is already loaded in the inventory. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 57 |
InventoryReassign |
NLAD etcCheck |
This API directly calls NLAD check API and returns the direct response from NLAD. |
SUBSCRIBER_NOT_FOUND (Expect the exact response from NLAD) |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 58 |
ValidatePortin |
This API is used to validate whether an MDN is eligible for Port In or not. |
To validate whether an MDN is eligible for Port In. |
Returns the validate portin message from carrier ELIGIBLE or NOT ELIGIBLE. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 59 |
QueryPortin |
Check the status of the Portin request. |
To query/check the status of a port in order. |
Returns the status of the port from the carrier if the port status is SUCESS, or PENDING, or RESOLUTION_REQUIRED. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 60 |
UpdatePortin |
Update Portin Information. |
To send an update on portin request to carrier for a pending port in Resolution Required Status. |
This API will update the port which is in Resolution Required status and returns the SUCCESS message. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 61 |
ExistingSubscriberPortin |
Portin a number on existing Subscriber. |
To send the portin request of the subscriber already existed in the system. |
This API will send the port request for the subscriber who is already existed in the system. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 62 |
CancelPortin |
Cancel portin request. |
To cancel a pending port in request. |
This API will cancel the port which is in pending status. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 63 |
GetCompany |
Get Company Details. |
To get the company/MVNO details. |
Returns Company ID, group ID, company name, company status and payment gateway type details. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 64 |
GetCompanyCarrier |
Get carrier details. |
To get the carrier available in the MVNO. |
This API returns the list of the carriers which have been configured for the MVNO in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 65 |
GetEmployeeDetail |
Get employee details. |
To get employee login id and its master/distributor/retailer details. |
This API returns employee details and there master agent, distributor and retailer names. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 67 |
GetUserLevelPermission |
Get User Level Permission. |
To get Get UserLevel Permission Agent login id . |
This API returns Agent chain and there master agent, distributor and retailer . |
For additional response codes, use cases please refer to STATUS CODES |
| 68 |
RemoveAgentPermission |
Remove Agent Permission. |
To Remove Agent Permission Agent login id . |
This API returns Agent Remove master agent, distributor and retailer . |
For additional response codes, use cases please refer to
STATUS CODES |
| 69 |
ChangePlanWithPayment |
Change the plan with payment. |
To change the plan of the existing subscriber's in Telgoo5. |
This API will change the subscriber's plan in Telgoo5 and at carrier level. This API will also send an update to NLAD for the lifeline subscriber's if there is a change in the NLAD plan service type. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 70 |
GetTransactionsHistory |
Get Transactions History. |
To get list of Transactions History in Telgoo5. |
Transactions History of payments |
For additional response codes, use cases please refer to STATUS CODES |
| 71 |
GetPendinAndPaidInvoice |
Get Transactions History. |
API is used to get pending and paid invoice on the account in Telgoo5. |
API is used to get pending and paid invoice on the account. |
For additional response codes, use cases please refer to STATUS CODES |
| 72 |
AddDealerWallet |
Add Dealer Wallet. |
To credit amount from the dealer wallet. |
Returns the amount added successfully of the dealer wallet. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 73 |
CustomerLogin |
Customer Login. |
Customer Login. |
Returns the successfully of the Customer Login. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 74 |
ResetPassword |
Reset Password. |
Reset Password. |
Returns the successfully of the Reset Password. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 75 |
ForgotPassword |
Forgot Password. |
Forgot Password. |
Returns the successfully of the Forgot Password. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 76 |
GetBackendConfig |
GetBackendConfig. |
GetBackendConfig. |
Returns the successfully of the Backend Config. |
For additional response codes, use cases please refer to STATUS CODES |
| 77 |
StoreLocator |
Store Locator |
StoreLocator |
API returns the list of the available store of the Zip code, City, State basis. This API can also be used to check whether store is available for a specific zip code. |
For additional response codes, use cases please refer to STATUS CODES |
| 78 |
CheckAutoPayStatus |
CheckAutoPayStatus |
This API is used to check auto pay status. |
This API used to get the auto pay status on the customer's account. If there was no auto-pay set up ever on the account it will return the result as "Autopay is not setup for this customer.". This currently the auto-pay is active on the account it will return the auto pay status as yes with the description of the service plan for which it is setup for. If auto-pay was set up on the account at some point in time but is currently cancelled then it will return the status as cancelled. |
For additional response codes, use cases please refer to STATUS CODES |
| 79 |
GetCarrierCode |
Returns the available carrier code and plan code list on the basis of carrier. |
To get the list of all the carrier code and plan code available on the given carrier on the basis of other validations required in the request. |
Returns the list of the carrier code and plan code for the provides carrier. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 80 |
SendNotification |
Send Notification |
To send Notification . |
|
For additional response codes, use cases please refer to STATUS CODES |
| 81 |
NewSignUpPayment |
New Sign Up Payment |
New Sign Up Payment . |
|
For additional response codes, use cases please refer to STATUS CODES |
| 82 |
GetBalanceInfo |
Returns subscriber information |
To get the information from the subscriber's account. |
Returns all the information associated with subscriber's account on the basis of customer id, enrollment id or telephone number or ESN. |
For additional response codes, use cases please refer to STATUS CODES |
| 83 |
CheckApplicationStatus |
Returns subscriber application information |
To get the information from the subscriber's account application. |
Returns all the information associated with subscriber's account application on the basis of enrollment id, SSN, first name, last name. |
For additional response codes, use cases please refer to STATUS CODES and USE CASE |
| 84 |
UpdateCustomerInfo |
UpdateCustomerInfo. |
UpdateCustomerInfo. |
Returns the successfully of the Update Customer Info. |
For additional response codes, use cases please refer to STATUS CODES |
| 85 |
CreateCustomerWithMultipleLine |
CreateCustomerWithMultipleLine. |
CreateCustomerWithMultipleLine. |
This API is used to create a prepaid subscriber for family plan and normal plan with parent and child in Telgoo5. This enables you to create a subscriber with a new number or a Port In. |
For additional response codes, use cases please refer to STATUS CODES |
| 86 |
StarzValidateCustomerPlan |
StarzValidateCustomerPlan. |
StarzValidateCustomerPlan. |
This API is used to validate customer plan is eligible for starz activation or not in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES |
| 87 |
StarzActivation |
StarzActivation. |
StarzActivation. |
This API is used to customer plan is eligible then it activate starz subscription in Telgoo5. |
For additional response codes, use cases please refer to STATUS CODES |
| 88 |
GetDealerWallet |
Get Dealer Wallet Balance. |
To get the dealer wallet balance. |
Returns the dealer wallet balance of the dealer. |
For additional response codes, use cases please refer to STATUS CODES |
| 89 |
FeaturesAddRemove |
Features Add Remove. |
This API used to add/Remove temporary or permanent feature on the customer's account. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 90 |
RenewPlan |
Renew Plan. |
This API used to renew plan on the customer's account. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 91 |
AgentResetPassword |
Agent Reset Password. |
This API is used to reset the agent(employee) account password. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 92 |
CreateTicket |
Create Ticket. |
This API is used to create ticket. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 93 |
RegisterSponsor |
Register Sponsor ID. |
This API is used to register sponsor ID. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 94 |
GetSponsor |
Get Sponsor ID. |
This API is used to get sponsor ID. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 95 |
GetSponsor |
Add Activity Log |
This API is used to Add Activity Log. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 96 |
EquipmentPurchase |
Equipment Purchase |
This API is used to Equipment Purchase. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 97 |
AddUpdatePhoneRequest |
Add Update Phone Request |
This API is used to Add and Update Phone Request. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 98 |
ViewPhoneRequest |
Add Update Phone Request |
This API is used to get phone request. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 99 |
GetRequestPhonePrice |
Get Request Phone Price Details |
This API is used to get request phone price details. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 100 |
CustomerClassification |
get the Customer Enrollment Classification |
This API is used to get the Customer Enrollment Classification. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 101 |
StackPlanGetAndCancel |
get and Cancel Stack Plan |
This API is used to get and Cancel Stack Plan. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 102 |
UploadProof |
Capture the customer eligibility proof. |
This API is used to Capture the customer eligibility proof. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 103 |
SimActivation |
Sim Activation. |
This API is used to Sim Activation. |
Returns the SUCCESS or FAIL. |
For additional response codes, use cases please refer to STATUS CODES |
| 104 |
FirstCallActivationPrepaid |
Changes the Telgoo5 status of a new subscriber to Active. |
To set the non-lifeline activation date and set the status of the account as Active for the first time enrolled subscriber on the basis of the first valid usage. |
After we call this API, it will check weather subscriber is in Dispatched status or not. If we find the subscriber in the dispatched status, system will check if the valid usage is found on the MDN or not, if the valid usage is found then this API proceeds to Activate the account. Also if the Telephone number is hotlined at carrier then it will also unhotline the line. |
For additional response codes, use cases please refer to STATUS CODES |
| 105 |
CancelPurchase |
Cancel purchase on the subscriber's account. |
Cancel purchase. |
This API will cancel purchase on subscriber's account on the basis of the MDN and plan code/purchase ID passed in the request. |
For additional response codes, use cases please refer to STATUS CODES |
| 106 |
AdjustBalance |
Adjust balance on the subscriber's account. |
Adjust Balance. |
This API will adjust balance on subscriber's account on the basis of the MDN, subscription id and UOM passed in the request. |
For additional response codes, use cases please refer to STATUS CODES |
| 107 |
GetChainPermissions |
Get Chain Permissions. |
GetChainPermissions. |
This API will get chain permissions. |
For additional response codes, use cases please refer to STATUS CODES |
| 108 |
QueryDevice |
Query Device. |
QueryDevice. |
This API will get Query Device. |
For additional response codes, use cases please refer to STATUS CODES |
| 109 |
AddressValidation |
AddressValidation. |
AddressValidation. |
This API will get Query Device. |
For additional response codes, use cases please refer to STATUS CODES |
| 110 |
EligibilityCheckNatonalVerifier |
EligibilityCheckNatonalVerifier. |
EligibilityCheckNatonalVerifier. |
This API will get Query Device. |
For additional response codes, use cases please refer to STATUS CODES |