Telgoo5 APIs

GetCustomerInfo

This XML API is used to get the information from the subscriber's account.

End Point	https://www.vcareapi.com/vcareOssApi/GetCustomerInfo/
Field (Short Description)	Value/Tag Name	Format	Field Example	Type	Notes	Validation rules
VENDOR ID		string	Vcarecorporation	Required	A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME		string	Vcarecorporation	Required	A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD		string	Vcarecorporation	Required	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 and can be obtained by contacting your account manager.
PIN		string	123456789	Required	This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCE NUMBER		string	123456789	Required	Auto generated unique reference number is required to be passed with each transaction.
CUSTOMERID		Numebric	123456	Conditional	Auto generated customer account number	If you are not passing MDN and enrollmentid then customer id is required
ENROLLMENT ID		string	123456	Conditional	Auto generated customer account number	If you are not passing customerid and telephonenumber then enrollmentid is required
MDN		Numebric	1234567890	Conditional	This is the telephone number which is attached to the subscriber's account	MDN and Last name is supposed to be passed together. If you are passing the Customer Id then MDN and enrollmentid are not required
LAST NAME		string	28	Conditional	Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.	MDN and Last name is supposed to be passed together. If you are passing the Customer Id then MDN and Last name are not required
EMAIL		string	noemail@gmail.com	Optional	This is the email address of the applicant.
ESN/SIM NUMBER		string	32323131317768	Optional	This is the SIM/ESN number of the applicant.	If you are not passing MDN, enrollmentid,esnnumber then customer id is required
ADDITIONAL INFORMATION		char	Y OR N	Optional	If Need to show m_name,ben_fname,ben_middlename,ben_lastname,dob,primary_phone field value must be Y	Expected Value: Y, N
GET EMAIL		char	Y OR N	Optional	If Need to show email field value must be Y	Expected Value: Y, N
GET RECERTIFICATION STATUS		char	Y OR N	Optional	If Need to show recertification field value must be Y	Expected Value: Y, N
ILD INFO		char	Y OR N	Optional	If Need to show ILD info field value must be Y	Expected Value: Y, N
PLAN INFO REQUIRED		char	Y OR N	Optional	If Need to show PLANINFOREQUIRED info field value must be Y	Expected Value: Y, N
FEDERAL DISCOUNT		char	Y OR N	Optional	If Need to show federal discount info field value must be Y	Expected Value: Y, N
GET USAGES		char	Y OR N	Optional	If Need to not show usages info field must be value N. If GETUSAGES is passed as Y then the API can take more then 10 seconds to return a response. If passed as N then it will be quicker and a response will be returned under 10 seconds.	Expected Value: Y, N
BALANCE ENQUIRY		char	Y OR N	Optional	If Need to not show balance enquiry info field must be value N, If BALANCEENQUIRY is passed as Y then the API can take more then 10 seconds to return a response. If passed as N then it will be quicker and a response will be returned under 10 seconds.	Expected Value: Y, N
GET STACKED PLAN		char	Y OR N	Optional	If Need to not show stacked plan info field must be value N, If stacked plan is passed as Y then the API can take more then 5 seconds to return a response. If passed as N then it will be quicker and a response will be returned under 5 seconds.	Expected Value: Y, N
PLAN PRICE WITH TAX		string	Y OR N	Optional	If Need to show PLANPRICEWITHTAX info field value must be Y	Expected Value: Y, N
AGENTID		string	John Doe	Required	This is the Telgoo5 user id. For the Agent/Employee who is sending the API request.
AGENTPASSWORD		string	John Doe	Conditional	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 XML API transaction, else if you have set the permissions to password not required then you don’t need to pass the Agent Password in the XML API.
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE,POS

Sample Request XML

<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss"
mlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
<VENDORID></VENDORID>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<GETCUSTOMERINFO>
		<CUSTOMERID></CUSTOMERID>
		<ENROLLMENTID></ENROLLMENTID>
		<TELEPHONENUMBER></TELEPHONENUMBER>
		<LASTNAME></LASTNAME>
		<EMAIL></EMAIL>
		<ESNNUMBER></ESNNUMBER>
		<ADDITIONALINFORMATION></ADDITIONALINFORMATION>
		<GETEMAIL></GETEMAIL>
		<GETRECERTIFICATION></GETRECERTIFICATION>
		<ILDINFO></ILDINFO>
		<PLANINFOREQUIRED></PLANINFOREQUIRED>
		<FEDERALDISCOUNT></FEDERALDISCOUNT>
		<GETUSAGES></GETUSAGES>
		<BALANCEENQUIRY></BALANCEENQUIRY>
		<GETSTACKEDPLAN></GETSTACKEDPLAN>
		<PLANPRICEWITHTAX></PLANPRICEWITHTAX>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</GETCUSTOMERINFO>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
243	Record(s) not found.	Please provide valid value as Record(s) not found.
299	Telephone number OR last name required.	Please provide Telephone number or last name.
332	MDN not found in System.	MDN is not found in System.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
756	Invalid telephone number.	Please provide a valid telephone number. Given value is invalid for telephone number.

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
<vendorId></vendorId>
<referenceNumber></referenceNumber>
</credentials>
<GetCustomerInfo>
<statusCode></statusCode>
<description></description>
<errorDescription></errorDescription>
<CustomerDetails>
	<CustomerID></CustomerID>
	<FirstName></FirstName>
	<LastName></LastName>
	<Email></Email>
	<recertification_status></recertification_status>
	<anniversary_date></anniversary_date>
	<recertification_datetime></recertification_datetime>
	<recertification_type></recertification_type>
	<recert_proof></recert_proof>
	<recert_year></recert_year>
	<CreatedDate></CreatedDate>
	<SSNNumber></SSNNumber>
	<LifeLine></LifeLine>
	<LinkUp></LinkUp>
	<ServiceAddress1>115 20TH ST</ServiceAddress1>
	<ServiceAddress2></ServiceAddress2>
	<City>ALEXANDRIA</City>
	<State>LA</State>
	<Zip>71301</Zip>
	<ShippingAddress1>115 20TH ST</ShippingAddress1>
	<ShippingAddress2></ShippingAddress2>
	<BillingState>LA</BillingState>
	<BillingCity>ALEXANDRIA</BillingCity>
	<BillingZip>71301</BillingZip>
	<ESNNumber></ESNNumber>
	<TelephoneNumber></TelephoneNumber>
	<LineStatus></LineStatus>
	<CompanyId></CompanyId>
	<serviceType></serviceType>
	<uiccid></uiccid>
	<deviceId></deviceId>
	<AccountStatus></AccountStatus>
	<DisconnectDate></DisconnectDate>
	<DisconnectedBy></DisconnectedBy>
	<ReconnectionDate></ReconnectionDate>
	<Carrier></Carrier>
	<CustPlanType></CustPlanType>
	<PlanID></PlanID>
	<currentplan></currentplan>
	<bill_to_customer_line_amount></bill_to_customer_line_amount>
	<currentplancode></currentplancode>
	<futureplan></futureplan>
	<balance_inwallet></balance_inwallet>
	<balance></balance>
	<databalance></databalance>
	<databalancebyte></databalancebyte>
	<expirydate></expirydate>
	<smsbalance></smsbalance>
	<usage>
		<voiceminutes></voiceminutes>
		<smsmessages></smsmessages>
		<datakilobytes></datakilobytes>
	</usage>
	<carrier_live_status></carrier_live_status>
	<planInformation>
		<planDetail></planDetail>
		<talk></talk>
		<text></text>
		<data></data>
		<accountType></accountType>
		<planTotalPrice></planTotalPrice>
		<planStatus></planStatus>
		<bill_to_customer></bill_to_customer>
		<is_unlimited_plan></is_unlimited_plan>
		<data_unlimited></data_unlimited>
		<text_unlimited></text_unlimited>
		<minute_unlimited></minute_unlimited>
		<grace_period_allowed_days></grace_period_allowed_days>
		<grace_period_plan_name></grace_period_plan_name>
	</planInformation>
	<Discount>
		<totalDiscount></totalDiscount>
	</Discount>
	<ildpromobalancetype></ildpromobalancetype>
	<ildpromobalance></ildpromobalance>
	<ildunlimitedenabledbalancetype></ildunlimitedenabledbalancetype>
	<ildunlimitedenabledbalance></ildunlimitedenabledbalance>
	<ildbalancetype></ildbalancetype>
	<ildbalance></ildbalance>
	<invoice_detail>
		<invoice_1>
			<invoice_no></invoice_no>
			<invoice_amount></invoice_amount>
			<duedate></duedate>
		</invoice_1>
	<total_due_amount></total_due_amount>
	</invoice_detail>
	<SuspendBy></SuspendBy>
	<CreatedDate></CreatedDate>
	<CreatedBy></CreatedBy>
	<invoicenumber></invoicenumber>
	<inv_datetime></inv_datetime>
	<dueamount></dueamount>
	<processingfee></processingfee>
	<isupgradetopupenble></isupgradetopupenble>
	<AgentName></AgentName>
	<MasterAgent></MasterAgent>
	<OrderBy></OrderBy>
	<NETIP_ACCOUNT_ID></NETIP_ACCOUNT_ID>
	<prepaid_credit_card_autopay_discount></prepaid_credit_card_autopay_discount>
	<prepaid_ach_autopay_discount></prepaid_ach_autopay_discount>
	<stackedplan></stackedplan>
	<StackedPlanList>
		<old_plan></old_plan>
		<new_plan></new_plan>
		<plan_effective_date></plan_effective_date>
		<plan_change_mode></plan_change_mode>
		<requestid></requestid>
	</StackedPlanList>
	</CustomerDetails>
	<refillamount count="8">
		<reload_value_1></reload_value_1>
		<reload_value_2></reload_value_2>
		<reload_value_3></reload_value_3>
		<reload_value_4></reload_value_4>
		<reload_value_5></reload_value_5>
		<reload_value_6></reload_value_6>
		<reload_value_7></reload_value_7>
		<reload_value_8></reload_value_8>
	</refillamount>
	<upgradeplanamount count="3">
		<upgradepla_value_1></upgradepla_value_1>
		<upgradepla_value_2></upgradepla_value_2>
		<upgradepla_value_3></upgradepla_value_3>
	</upgradeplanamount>
</GetCustomerInfo>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared separately.

</CreatedDate>This is the lifeline activation date of the subscriber.
<SSNNumber>Social security number of the subscriber
</LifeLine>This determines if it is a lifeline subscriber or not.
</futureplan>: This is the plan if any on which subscriber is supposed to be switched on any particular date as setup
</balance_inwallet>This is the dollar amount available in subscriber's wallet.
<balance>This is the voice balance available in customer's account.
<b>0.00 GB</b>This is the limit of the data usage on the account if any.
</databalancebyte>This is the amount of data balance
</expirydate>This is the expiration date of the plan
</smsbalance>This is SMS balance
</dueamount> or </total_due_amount>This is the amount of the bill due
</isupgradetopupenble>This is not applicable for you.
</reload_value_1>These are the values and prices of add-ons available on that account
<LineStatus> This field is not in use

Sample Fail Response: 1

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

Sample Fail Response: 2

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

Sample Fail Response: 3

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>243</statusCode>
	<description>FAIL</description>
	<errorDescription>Record(s) not found.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Record(s) not found.

How to Resolve?: Please provide valid value as Record(s) not found.

Sample Fail Response: 4

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>299</statusCode>
	<description>FAIL</description>
	<errorDescription>Telephone number OR last name required.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Telephone number OR last name required.

How to Resolve?: Please provide Telephone number or last name.

Sample Fail Response: 5

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>332</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN not found in System.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: MDN not found in System.

How to Resolve?: MDN is not found in System.

Sample Fail Response: 6

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

Sample Fail Response: 7

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

Sample Fail Response: 8

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
	<GetCustomerInfo>
	<statusCode>756</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid telephone number.</errorDescription>
</GetCustomerInfo>
</VcareOssApi>

Error Description: Invalid telephone number.

How to Resolve?: Please provide a valid telephone number. Given value is invalid for telephone number.

All the status codes are listed under the status code sections. Please click here to go to the status code.