Telgoo5 APIs

UpdateAccountStatus

This API can be used to update subscribers account status. This will allow you to suspend/restore and deactivate a subscribers account. Deactivating subscriber using this api will remove the susbscriber from NLAD as well as carrier.

End Point	https://www.vcareapi.com/vcareOssApi/UpdateAccountStatus/
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.
CUSTOMER ID		Numeric	123456	Conditional	Auto generated customer account number. This is returned in GetCustomerInfo.
MDN		Numeric	1234567890	Optional	This is the telephone number which is attached to the subscriber's account
NEW STATUS		string	Inactive	Required	Suspending a subscriber account status hotlines the subscribers to customer service and changes the account status to Suspend. Restore removes the hotline and changes the account status back to Active. Inactive will change the account status to Inactive and will Inactivate the account. Re-connect will reactivate the account when curent account status is Inactive.	Restore, Suspend, Inactive, Re-connect
ACCOUNT TYPE		string	Electronically	Required	Electronically- Changes the status in Telgoo5, NLAD/Xerox and carrier . Non Electronically - Updates the status only in Telgoo5.	Electronically, Non Electronically
INACTIVE ISSUES ID		Numeric	5	Conditional	This is the reason for Inactivating an account. This accepts the Inactive reasons codes ID. You can get this ID from another API called "GetInactiveReasons". You can pass empty value when NEW STATUS is not Inactive.	Numeric
ASSIGN INVENTORY TO		String	test123	Conditional	Only applicable where New status = Re-connect. This is the employee login id who will be assigned with the inventory.	test123
SEND TO NLAD		String	Y	Conditional	Only applicable where New status = Re-connect and account is a lifeline account. NOt required incase of Prepaid.	Y or N
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENT PASSWORD		string	JohnDoe	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.

Sample Request XML

<?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>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
<UPDATEACCOUNTSTATUS>
<CUSTOMERID></CUSTOMERID>
<MDN></MDN>
<NEWSTATUS></NEWSTATUS>
<ACCOUNTTYPE></ACCOUNTTYPE>
<INACTIVEISSUESID></INACTIVEISSUESID>
<ASSIGNINVENTORYTO></ASSIGNINVENTORYTO>
<SENDTONLAD></SENDTONLAD>
<AGENTID></AGENTID>
<AGENTPASSWORD></AGENTPASSWORD>
<SOURCE></SOURCE>
</UPDATEACCOUNTSTATUS>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
01	Error Received from Carrier.	Please try again with valid data.
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
92	Invalid Inactive Issues.	Provide a valid Inactive Issues.
160	Assign inventory to (Employee Login ID) should not be blank.	Assign inventory to (Employee Login ID) should not be blank.
161	Assign inventory to login id not found.	Please provide valid value as Assign inventory to login id not found.
162	Assign inventory to login id is inactive.	Please provide valid value as Assign inventory to login id is inactive.
226	Customer ID is required.	Please provide Customer ID.
321	Customer not found.	Customer is not found.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
405	Customer Account Type not matched.	Customer Account Type is different and not matched.
447	Inactive Issues ID should not be blank.	Inactive Issues ID can not be blank. You should enter a valid Inactive Issues ID.
448	Customer Account Type should not be blank.	Customer Account Type can not be blank. You should enter a valid Customer Account Type.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
518	New status should not be blank.	Provide correct New status. New status should not be blank.
519	New status not matched.	New status is not matched in system.
595	should be Y OR N.	should be Y OR N. is a dynamic value.
642	Customer already	Customer already
643	New status should be:	New status is

Sample Response XML

<?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>
   <UpdateAccountStatus>
        <statusCode>00</statusCode>
        <description>00</description>
        <errorDescription>SUCCESS</errorDescription>
    </UpdateAccountStatus>
</VcareOssApi>

SUCCESS.

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>
<UpdateAccountStatus>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Error Received from Carrier.

How to Resolve?: Please try again with valid data.

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>
<UpdateAccountStatus>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<UpdateAccountStatus>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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>
<UpdateAccountStatus>
	<statusCode>92</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Inactive Issues.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Invalid Inactive Issues.

How to Resolve?: Provide a valid Inactive Issues.

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>
<UpdateAccountStatus>
	<statusCode>160</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign inventory to (Employee Login ID) should not be blank.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Assign inventory to (Employee Login ID) should not be blank.

How to Resolve?: Assign inventory to (Employee Login ID) should not be blank.

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>
<UpdateAccountStatus>
	<statusCode>161</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign inventory to login id not found.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Assign inventory to login id not found.

How to Resolve?: Please provide valid value as Assign inventory to login id not found.

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>
<UpdateAccountStatus>
	<statusCode>162</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign inventory to login id is inactive.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Assign inventory to login id is inactive.

How to Resolve?: Please provide valid value as Assign inventory to login id is inactive.

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>
<UpdateAccountStatus>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Customer ID is required.

How to Resolve?: Please provide Customer ID.

Sample Fail Response: 9

<?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>
<UpdateAccountStatus>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Customer not found.

How to Resolve?: Customer is not found.

Sample Fail Response: 10

<?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>
<UpdateAccountStatus>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

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

Sample Fail Response: 11

<?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>
<UpdateAccountStatus>
	<statusCode>405</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer Account Type not matched.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Customer Account Type not matched.

How to Resolve?: Customer Account Type is different and not matched.

Sample Fail Response: 12

<?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>
<UpdateAccountStatus>
	<statusCode>447</statusCode>
	<description>FAIL</description>
	<errorDescription>Inactive Issues ID should not be blank.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Inactive Issues ID should not be blank.

How to Resolve?: Inactive Issues ID can not be blank. You should enter a valid Inactive Issues ID.

Sample Fail Response: 13

<?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>
<UpdateAccountStatus>
	<statusCode>448</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer Account Type should not be blank.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Customer Account Type should not be blank.

How to Resolve?: Customer Account Type can not be blank. You should enter a valid Customer Account Type.

Sample Fail Response: 14

<?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>
<UpdateAccountStatus>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Invalid Source.

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

Sample Fail Response: 15

<?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>
<UpdateAccountStatus>
	<statusCode>518</statusCode>
	<description>FAIL</description>
	<errorDescription>New status should not be blank.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: New status should not be blank.

How to Resolve?: Provide correct New status. New status should not be blank.

Sample Fail Response: 16

<?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>
<UpdateAccountStatus>
	<statusCode>519</statusCode>
	<description>FAIL</description>
	<errorDescription>New status not matched.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: New status not matched.

How to Resolve?: New status is not matched in system.

Sample Fail Response: 17

<?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>
<UpdateAccountStatus>
	<statusCode>595</statusCode>
	<description>FAIL</description>
	<errorDescription> should be Y OR N.</errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: should be Y OR N.

How to Resolve?: should be Y OR N. is a dynamic value.

Sample Fail Response: 18

<?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>
<UpdateAccountStatus>
	<statusCode>642</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer already </errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: Customer already

How to Resolve?: Customer already

Sample Fail Response: 19

<?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>
<UpdateAccountStatus>
	<statusCode>643</statusCode>
	<description>FAIL</description>
	<errorDescription>New status should be: </errorDescription>
</UpdateAccountStatus>
</VcareOssApi>

Error Description: New status should be:

How to Resolve?: New status is

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