Telgoo5 APIs

ChangeCarrier

This XML API is used to Change Carrier the ESN/SIM on the subscriber's account.

End Point	https://www.vcareapi.com/vcareOssApi/ChangeCarrier/
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	123456
MDN		Numeric	1234567890	Conditional	This is the telephone number which is attached to the subscriber's account
NEW ESN		Alphanumeric	8901260713156280780	Required	This is the New ESN/SIM. Make sure you check the status of the ESN/SIM using the Devicelookup API to check if it is provisioned or Not provisioned and to get Model and Price of the New ESN/SIM	Can be alpha numeric. Max length = 30
NEW PLAN ID		Alphanumeric	100T	Required	Please provide carrier code of new plan ID where new ESN will get activated.
CHANGE REASON		string	change_esn_reason_bad	Required	This is the reason for ESN/SIM swap. Based on the reason, it will set the existing ESN/SIM status in the inventory. change_esn_reason_bad = This will set the old ESN/SIM into BAD status in inventory. lost_by_customer = This will set the old ESN/SIM status as REMOVED in the inventory. courtesy_change = This will set the old ESN/SIM status as FREE in the inventory.	change_esn_reason_bad courtesy_change
REASON FOR BAD		string	Device not turning on.	Conditional	This is note field applicable when CHANGEREASON is = change_esn_reason_bad.	Max 100 characters
STORE ID		string	John Doe	Required	This is the login id of the store type to which the old inventory needs to be reassigned to.
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	John Doe	Required	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	Required	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" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
<VENDORID>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>Vcarecorporation</PIN>
<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
<CHANGECARRIER>
	<CUSTOMERID></CUSTOMERID>
	<MDN></MDN>
	<NEWESN></NEWESN>
	<NEWPLANID></NEWPLANID>
	<CHANGEREASON></CHANGEREASON>
	<REASONFORBAD></REASONFORBAD>
	<STOREID></STOREID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
</CHANGECARRIER>
 </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.
25	Customer ID is invalid.	Provide a valid Customer ID.
170	Carrier ID is required.	Please provide a Carrier ID.
351	ESN must be greater than 8 and less than 26 characters.	Please provide a valid ESN and it must be greater than 8 and less than 26 characters.
367	MDN should be 10 digits.	Please provide a valid MDN and it should be 10 digits.
373	New ESN is required.	Please provide New ESN as its required.
564	Customer ID OR MDN is required.	Choose between Customer ID or MDN. Customer ID or MDN is required.
751	Custom message.	This is dynamic message.
818	New Plan ID is required.	Please provide a New Plan ID.
821	Reason for Bad is required.	Please provide Reason for Bad.

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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
     <SwapESN>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </SwapESN>
</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>
<SwapESN>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</SwapESN>
</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>
<SwapESN>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: Customer ID is invalid.

How to Resolve?: Provide a valid Customer ID.

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>
<SwapESN>
	<statusCode>170</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier ID is required.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: Carrier ID is required.

How to Resolve?: Please provide a Carrier ID.

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>
<SwapESN>
	<statusCode>351</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: ESN must be greater than 8 and less than 26 characters.

How to Resolve?: Please provide a valid ESN and it must be greater than 8 and less than 26 characters.

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>
<SwapESN>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: MDN should be 10 digits.

How to Resolve?: Please provide a valid MDN and it should be 10 digits.

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>
<SwapESN>
	<statusCode>373</statusCode>
	<description>FAIL</description>
	<errorDescription>New ESN is required.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: New ESN is required.

How to Resolve?: Please provide New ESN as its required.

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>
<SwapESN>
	<statusCode>564</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID OR MDN is required.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: Customer ID OR MDN is required.

How to Resolve?: Choose between Customer ID or MDN. Customer ID or MDN is required.

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>
<SwapESN>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: Custom message.

How to Resolve?: This is dynamic message.

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>
<SwapESN>
	<statusCode>818</statusCode>
	<description>FAIL</description>
	<errorDescription>New Plan ID is required.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: New Plan ID is required.

How to Resolve?: Please provide a New Plan ID.

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>
<SwapESN>
	<statusCode>821</statusCode>
	<description>FAIL</description>
	<errorDescription>Reason for Bad is required.</errorDescription>
</SwapESN>
</VcareOssApi>

Error Description: Reason for Bad is required.

How to Resolve?: Please provide Reason for Bad.

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