GetUsagesDetails

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

End Point https://www.vcareapi.com/vcareOssApi/GetUsagesDetails/
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.
TELEPHONENUMBER string 1234567890 Conditional This is the telephone number which is attached to the subscriber's account
DATEFROM string Required This is the date MM/DD/YYYY is expected. hyphen allowed.
DATETO string Required This is the date MM/DD/YYYY is expected. hyphen allowed.
MIN Number 1 Optional This is the paging min value.
MAX Number 10 Optional This is the paging max value.
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE,POS
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.
Sample Request
<?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>
<GETUSAGESDETAILS>
	<TELEPHONENUMBER></TELEPHONENUMBER>
	<DATEFROM></DATEFROM>
	<DATETO></DATETO>
	<MIN></MIN>
	<MAX></MAX>
	<SOURCE></SOURCE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
</GETUSAGESDETAILS>
</VCAREOSS>
</VCAREOSSAPI>
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>dev-vertexvoice</vendorId> 
<referenceNumber>4053391535</referenceNumber> 
</credentials>
<GetUsagesDetails>
	<statusCode></statusCode>
	<description></description>
	<errorDescription></errorDescription><usages>
	<totalusage>
		<voiceminutes></voiceminutes>
		<smsmessages></smsmessages>
		<datamb></datamb>
	</totalusage>
	<usagesdetails>
	<details>
		<resource></resource>
		<otherpartynumber></otherpartynumber>
		<effectivedate></effectivedate>
		<redirectingparty></redirectingparty>
		<unit></unit>
		<unitun></unitun>
		<calltype></calltype>
		<usagetype></usagetype>
		<dialleddigit></dialleddigit>
	</details>
	</usagesdetails>
	</usages>
</GetUsagesDetails>

</VcareOssApi>

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