Telgoo5 APIs

SimActivation

This XML API is used the SIM/ESN Activation.

End Point	https://www.vcareapi.com/vcareOssApi/SimActivation/
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	Reference number is required to be passed with each transaction.
ESN / SIM		String	8901123654789654123	Required	This is the SIM/ESN which needs to be Activation.
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.
SOURCE		String	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE

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>
 <SIMACTIVATION>
	<ESN></ESN>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
  </SIMACTIVATION>
 </VCAREOSS>
</VCAREOSSAPI>

List of status code and description.
Status Code	Description
00	SUCCESS
04	ESN does not exist in system.
13	Password is invalid.
16	Vendor not found. Wrong credentials.
158	ESN/SIM is required.
351	ESN must be greater than 8 and less than 26 characters.
751	Custom message.

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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
    <SimActivation>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <response_error></response_error>
        <response>SUCCESSFULLY ACTIVATED</response>
       <mdn></mdn>
	 </SimActivation>
</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>
<SimActivation>
	<statusCode>04</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN does not exist in system.</errorDescription>
</SimActivation>
</VcareOssApi>

ESN does not exist in system.

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

Password is invalid.

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

Vendor not found. Wrong 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>
<SimActivation>
	<statusCode>158</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM  is required.</errorDescription>
</SimActivation>
</VcareOssApi>

ESN/SIM is required.

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

ESN must be greater than 8 and less than 26 characters.

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

Custom message.

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