| 1 |
address |
address_validation |
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 |
| 2 |
customer |
create_customer_prepaid |
For create non life line customer. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 3 |
customer |
create_customer_prepaid_multiline |
For adding line while creating non life line customer. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 4 |
customer |
verify_contact_detail |
Verify customer Email or Telephone Number. |
This API verify customer Email or Telephone Number. |
This API verify customer Email or Telephone Number. |
For additional response codes, use cases please refer to STATUS CODES |
| 5 |
customer |
create_lifeline_customer |
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 |
| 6 |
customer |
line_inquiry |
To get the current carrier status. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 7 |
enrollment |
check_service_availability |
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 |
| 8 |
equipment |
equipment_purchase |
For purchase Equipment |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 9 |
handover |
handover_activation |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 10 |
nlad |
nlad_etc_check |
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 |
| 11 |
nlad |
nlad_verify |
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 |
| 12 |
nlad |
tpiv_listing |
For getting TPIV List |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 13 |
nlad |
eligibility_check |
For getting eligibility status |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 14 |
nlad |
eligibility_status_check |
For getting eligibility status Check |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 15 |
plan |
plan_list |
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 |
| 16 |
programs |
programs_income_list |
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 |
| 17 |
solix |
get_tspid_provider |
This RESTAPI is used for getting list of TSP providers. |
Get TSP provider list |
|
For additional response codes, use cases please refer to STATUS CODES |
| 18 |
enrollment |
update_enrollment_detail |
Use for update enrollment details. |
This API is used for update the enrollment details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 19 |
features |
change_feature |
Use to to change features. |
This API is used to to change features. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 20 |
cards |
saved_card_list |
Use to fetch saved card list. |
This API is used to fetch saved card list |
|
For additional response codes, use cases please refer to STATUS CODES |
| 21 |
cards |
add_card |
use to save new card details. |
This API is used to save new card details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 22 |
auth |
access_wireless_customer_verify |
Use for access wireless customer verify |
This API is use for access wireless customer verify |
|
For additional response codes, use cases please refer to STATUS CODES |
| 23 |
wallet |
add_wallet |
Use for add amount in wallet. |
This RESTAPI is use to add amount in wallet. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 24 |
notification |
get_notification_list |
Use for get notification list. |
This RESTAPI is used to get notification list. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 25 |
auth |
verify_customer_email |
Use for get verify customer email. |
This RESTAPI is used for verify customer email |
|
For additional response codes, use cases please refer to STATUS CODES |
| 26 |
nlad |
nlad_verify_ebb |
Use for nlad verify. |
The API used for nlad verify. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 27 |
payment |
cancel_insurance_subscription |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 28 |
nlad |
verify_device_eligibility |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 29 |
company |
update_company_information |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 30 |
company |
update_sac_code |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 31 |
nlad |
nlad_transfer_acp |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 32 |
notes |
add_notes |
For adding notes |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 33 |
auth |
customer_login |
Customer Login. |
Customer Login. |
Returns the successfully of the Customer Login. |
For additional response codes, use cases please refer to STATUS CODES |
| 34 |
auth |
change_password |
Change Password. |
Change Password. |
Returns the successfully of the Change Password. |
For additional response codes, use cases please refer to STATUS CODES |
| 35 |
autopay |
set_autopay |
For Set Autopay |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 36 |
autopay |
check_autopay |
For check Autopay |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 37 |
autopay |
cancel_autopay |
For Cancel Autopay |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 38 |
customer |
customer_info |
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 |
| 39 |
customer |
change_account_status |
For updating the status of the customer. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 40 |
topup |
topup_list |
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 |
| 41 |
topup |
add_topup |
Returns the available Add-on/topups. |
For add topup on MDN. |
It will return the success message if your transaction is successful . Otherwise it will return the error. |
For additional response codes, use cases please refer to STATUS CODES |
| 42 |
usage |
get_usage |
Returns the usage info. |
To get the usage of customer. |
This API will return all the usage of customer. |
For additional response codes, use cases please refer to STATUS CODES |
| 43 |
enrollment |
get_enrollments |
Get the enrollments details |
Get the enrollments details |
|
For additional response codes, use cases please refer to STATUS CODES |
| 44 |
customer |
update_information |
Update the customer information |
This RESTAPI is use for updating the customer information. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 45 |
customer |
ebb_qualify |
Use for EBB qualify |
This RESTAPI is use for EBB qualify. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 46 |
cards |
remove_card |
Use for remove saved credit card. |
This RESTAPI is use for remove saved credit card. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 47 |
cards |
update_card |
Use for update credit card details. |
This RESTAPI is use for update credit card details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 48 |
fraud_prevention |
validate_customer |
Use for validate the customer |
This API is use for validate the customer |
|
For additional response codes, use cases please refer to STATUS CODES |
| 49 |
port |
get_list |
Use for get port list |
This API is use for get port list |
|
For additional response codes, use cases please refer to STATUS CODES |
| 50 |
port |
update_portin |
Use for update the portin. |
This RESTAPI is use for update the portin. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 51 |
port |
submit_portin |
Use for submit portin. |
This RESTAPI is use for submit portin. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 52 |
port |
query_portin |
Use for query_portin. |
This RESTAPI is use for query portin. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 53 |
inventory |
first_call_activation |
Use for first call activation. |
This RESTAPI is used for first call activation. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 54 |
inventory |
sim_swap |
Use for SIM swap. |
This RESTAPI is used for SIM swap. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 55 |
inventory |
device_swap |
Api use for swap the Device |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 56 |
customer |
remove_line |
Api use for remove line |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 57 |
customer |
check_applecare_status |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 58 |
notification |
update_notification_preferences |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 59 |
customer |
check_ca_recertification_status |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 60 |
customer |
ca_recertification_submit |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 61 |
inventory |
assign_device |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 62 |
coupon |
validate |
Take a payment |
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 |
| 63 |
payment |
payment_details |
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 |
| 64 |
payment |
get_invoices |
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 |
| 65 |
payment |
make_payment |
Take a payment |
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 |
| 66 |
payment |
make_payment_without_invoice |
Take a payment |
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 |
| 67 |
payment |
homephone_invoices |
Use for get all invoices of homephone orders. |
The API used for get all invoices of homephone orders of a customer. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 68 |
payment |
download_invoice |
Use for download invoice. |
The API used for download invoice. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 69 |
payment |
generate_paypal_braintree_token |
Use for generate paypal braintree token. |
The API used for generate paypal braintree token. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 70 |
payment |
calculate_tax_plum |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 71 |
payment |
update_tax_calculation_status_plum |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 72 |
payment |
update_bill_preferences |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 73 |
address |
get_city_state |
|
This API directly return city and state. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 74 |
address |
address_autocomplete |
NLAD verify |
This API suggested addresses. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 75 |
address |
change_address |
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 |
| 76 |
address |
get_area_code |
For purchase Equipment |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 77 |
auth |
agent_login |
Agent Login. |
Agent Login. |
Returns the successfully of the Agent Login. |
For additional response codes, use cases please refer to STATUS CODES |
| 78 |
carrier |
get_byod_carriers |
To get BYOD carrier List |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 79 |
customer |
contact_us |
For send us contact us message. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 80 |
customer |
create_homephone_customer |
To create homephone customer. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 81 |
equipment |
equipment_list |
Return the List of equipment |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 82 |
equipment |
equipment_purchase_history |
For Equipment purchase History |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 83 |
handover |
order_list |
Returns order lists. |
|
Returns the order lists. |
For additional response codes, use cases please refer to STATUS CODES |
| 84 |
handover |
order_status |
Returns order status. |
|
Returns the order status. |
For additional response codes, use cases please refer to STATUS CODES |
| 85 |
inventory |
check_esn_status |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 86 |
inventory |
validate_byod |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 87 |
payment |
refund_payment |
For refund the payment |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 88 |
plan |
change_plan |
Returns the status of the change plan success or Fail. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 89 |
rating |
add_rating |
It's used for add the rating of the model. |
|
After adding the rating return the success message. |
For additional response codes, use cases please refer to STATUS CODES |
| 90 |
rating |
get_rating |
It's used for get rating by rating id. |
|
It will return the all rating. |
For additional response codes, use cases please refer to STATUS CODES |
| 91 |
rating |
edit_rating |
It's used for edit existing rating. |
|
It will return the status after edit the rating. |
For additional response codes, use cases please refer to STATUS CODES |
| 92 |
recertification |
get_info |
Returns the available recertification info. |
To get the available recertification. |
This API will return all the recertification info. |
For additional response codes, use cases please refer to STATUS CODES |
| 93 |
auth |
agent_logout |
It used for logout agent. |
It used for logout agent. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 94 |
backend_config |
backend_config |
Returns all configs. |
It is used for getting all configs. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 95 |
check_agent_login |
check_agent_login |
Return the status of agent is login or not. |
This API is use to get the status whether agent is login or not. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 96 |
check_inventory_scan_status |
check_inventory_scan_status |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 97 |
agent |
check_signature |
Check the signature |
Check the signature |
|
For additional response codes, use cases please refer to STATUS CODES |
| 98 |
auth |
get_permissions |
It is used for getting the permission codes. |
Get permission code. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 99 |
agent |
update_location_coordinate |
Use for upload the signature. |
This RESTAPI is use for update location coordinate. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 100 |
agent |
get_permissions_chain |
Use for get permissions chain. |
This RESTAPI is use for get permissions chain. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 101 |
agent |
create_agent |
Use for create agent. |
This RESTAPI is used for create agent. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 102 |
agent |
locate_agent |
Use for locate agent. |
This RESTAPI is used for locate agent. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 103 |
inventory |
validate_portin |
Use for validate portin. |
This RESTAPI is used for validate portin. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 104 |
inventory |
reconcile_inventory |
Use for reconcile inventory. |
This RESTAPI is used for reconcile inventory. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 105 |
inventory |
check_device_compatibility |
Use for check device compatibility. |
This RESTAPI is used for check device compatibility. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 106 |
inventory |
sim_activation |
Use for SiM activation. |
This RESTAPI is used for SIM activation. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 107 |
auth |
agent_proof_status |
Use for get agent proof status. |
This RESTAPI is used for get agent proof status |
|
For additional response codes, use cases please refer to STATUS CODES |
| 108 |
auth |
agent_forgot_password |
Use for get agent forgot password. |
This RESTAPI is used for agent forgot password. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 109 |
agent |
update_agent |
Use for update agent. |
This RESTAPI is used for update agent. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 110 |
nlad |
check_nlad_status |
Use for check nlad status. |
The API used for check nlad status. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 111 |
pin |
redeem_pin |
Use for redeem pin. |
The API used for redeem pin. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 112 |
features |
get_wifi_calling |
Use for get wifi calling details like usage etc. |
The API used for get wifi calling details like usage etc. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 113 |
recertification |
create |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 114 |
inventory |
dropship_shipment |
Used for create doorship order |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 115 |
features |
update_roaming_status |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 116 |
notification |
get_notification_preferences |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 117 |
inventory |
validate_tac_number |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 118 |
shipping |
get_shipping_methods |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 119 |
address |
address_validation_usps |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 120 |
address |
check_duplicate_customer |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 121 |
agent |
sales_info |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 122 |
plan |
activation_count |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 123 |
inventory |
add_and_update_inventory |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 124 |
https://www.vcareapi.com:8080/inventory |
inventory |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 125 |
authenticate |
authenticate |
Get token for the REST API. |
Get token for the REST API. |
Returns token for the REST API. |
For additional response codes, use cases please refer to STATUS CODES |
| 126 |
address |
address_suggestions |
Get address suggestion from melissa. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 127 |
CPUC
|
ca_check_customer_status |
To Check user status regarding california enrollment. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 128 |
customer
|
upload_proof |
For upload customer proof. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 129 |
customer
|
upload_signature |
For upload customer signature. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 130 |
customer
|
get_name_suffix |
For get all suffix. |
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 131 |
handover
|
handover_view_inventory |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 132 |
handover
|
handover_process |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 133 |
enrollment
|
get_language_detail |
|
|
|
For additional response codes, use cases please refer to STATUS CODES |
| 134 |
address
|
verify_tribal_address |
Use to check with the given address lies tribal or non tribal area. |
This API is used to check with the given address lies tribal or non tribal area. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 135 |
features
|
feature_list |
Use to to get feature list. |
This API is used to to get feature list. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 136 |
cards
|
card_type |
use to card type list. |
This API is used to save new card details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 137 |
auth
|
customer_logout |
Use for destroy user session. |
This RESTAPI is use for destroy user session. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 138 |
auth
|
update_profile |
Use for update profile information. |
This RESTAPI is use for user profile updation. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 139 |
auth |
agent_proof |
Use for upload agent proof. |
This RESTAPI is use for user profile updation. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 140 |
auth |
agent_change_password |
Use for change agent password. |
This RESTAPI is use for user profile updation. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 141 |
notification
|
push_notification |
Use for push notification. |
This RESTAPI is used to push notification. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 142 |
port
|
send_notification |
Use for push notification. |
This RESTAPI is used to push notification. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 143 |
inventory
|
imei_lookup |
Use for get device details. |
This RESTAPI is used for device details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 144 |
inventory
|
device_lookup |
Use for get esn details. |
This RESTAPI is used for esn details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 145 |
inventory
|
get_esn_mdn |
Use for get esn mdn details. |
This RESTAPI is used for esn mdn details. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 146 |
inventory
|
get_esn_mdn_list |
Use for get esn mdn details list. |
This RESTAPI is used for esn mdn details list. |
|
For additional response codes, use cases please refer to STATUS CODES |
| 147 |
mail |
send |
Use for send mail. |
The API used for send mail. |
|
For additional response codes, use cases please refer to STATUS CODES |