Telgoo5 APIs

ChangeDevice

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.

End Point	https://www.vcareapi.com/vcareOssApi/ChangeDevice/
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.
OLD IMEI / DEVICE ID		Alphanumeric OR Numeric	5689223654789654123	Conditional	This is the IMEI/Device Id of the GSM handset currently assigned to the subscriber in the system. This is only applicable for GSM such as TMobile or AT&T.	Max 30 digits
NEW IMEI / DEVICE ID		Numeric	562323654789654123	Required	This is the new IMEI/Device Id of the GSM handset that needs to be assigned to the subscriber. This is only applicable for GSM such as TMobile or AT&T.	Max 30 digits
CUSTOMER ID		Numeric	1232	Required	Auto generated customer account number. This is returned in another api called GetCustomerInfo.
REASON FOR CHANGE DEVICE		string	courtesy_change	Required	This is the reason for IMEI swap. This based on the reason, it will set the existing IMEI status in the inventory. change_device_reason_bad = This will set the old IMEI into BAD status in inventory. lost_by_customer = This will set the old IMEI status as REMOVED in the inventory. courtesy_change = This will set the old IMEI status as FREE in the inventory.	change_device_reason_bad, lost_by_customer, courtesy_change
REASON FOR BAD DEVICE		string	Device not turning on.	Conditional	This is note field applicable when REASONFORCHANGEDEVICE is = change_device_reason_bad.	Max 1000 characters
MODEL ID		Numeric	5	Required	This is the model ID of the NEW IMEI/Device ID. This id can be obtained using another api called IMEI lookup.
EMPLOYEE ID OF WHO GOT THE OLD DEVICE BACK?		string	TestVcare	Required	This is the employee id for the individual who received the old gsm device back. Old IMEI is assigned back to the retailer of the employee chain.
COMPANY ID		Numeric	125	Required	A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCustomerInfo.
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD		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.
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE

Sample Request XML

<?xml version="1.0" encoding="utf-16"?>
<VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.oss.vcarecorporation.com/oss">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
  <CHANGEDEVICE>
	<OLDDEVICEID></OLDDEVICEID>
	<NEWDEVICEID></NEWDEVICEID>
	<CUSTID></CUSTID>
	<REASONFORCHANGEDEVICE></REASONFORCHANGEDEVICE>
	<REASONFORBADDEVICE></REASONFORBADDEVICE>
	<MODELID></MODELID>
	<STOREID></STOREID>
	<COMPANYID></COMPANYID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</CHANGEDEVICE>
</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.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
384	Device ID Changed Successfully.	Device ID is changed successfully.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.

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>
<ChangeDevice>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ChangeDevice>
</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>
<ChangeDevice>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ChangeDevice>
</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>
<ChangeDevice>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ChangeDevice>
</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>
<ChangeDevice>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ChangeDevice>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

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

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>
<ChangeDevice>
	<statusCode>384</statusCode>
	<description>SUCCESS</description>
	<errorDescription>Device ID Changed Successfully.</errorDescription>
</ChangeDevice>
</VcareOssApi>

Error Description: Device ID Changed Successfully.

How to Resolve?: Device ID is changed successfully.

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

Error Description: Invalid Source.

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

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