Telgoo5 APIs

CreateTicket

This XML API is used to create ticket on the customer's account.

End Point	https://www.vcareapi.com/vcareOssApi/CreateTicket/
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.
TELEPHONE NUMBER		string	1234567890	Required	This is the telephone number which is attached to the subscriber's account. This is returned in GetCustomerInfo	Numeric
FIRST NAME		string	John	Required	This is the first name of the customer. This is returned in GetCustomerInfo	Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.
LAST NAME		string	Doe	Required	This is the last name of the customer. This is returned in GetCustomerInfo	Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.
EMAIL		string	noemail@gmail.com	Optional	This is the email address of the customer. This is returned in GetCustomerInfo
TICKET TYPE		string	BUG	Optional	only string allow.
TICKET DESCRIPTION		string	text	Required	Descriptin of Ticket.
TICKET STATUS		string	Open	Required	Descriptin of Ticket.	Call Back, Closed, Escalation, Open, Pending
ASSIGN TICKET TO		string	User	Required	This is the assign type.	USER, GROUP
ASSIGN TO		string	TestEmp	Conditional	This is the Telgoo5 login Id of the agent you are assigning the ticket to. if Assign ticket to USER then required.
AGENTID		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	This is the source where the API. This could be API, TABLET, IVR, WEBSITE etc.

Sample Request XML

<?xml version="1.0" encoding="UTF-8"?>
<VcareOssApi>
<CREDENTIALS>
	<VENDORID>XXXXXXXX</VENDORID>
	<USERNAME>XXXXXXXXXX</USERNAME>
	<PASSWORD>XXXXXXXXX</PASSWORD>
	<PIN>XXXXXXXXXXX</PIN>
	<REFERENCENUMBER>XXXXXXXXXXXXX</REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<CREATETICKET>
		<TELEPHONENUMBER></TELEPHONENUMBER>
		<FIRSTNAME></FIRSTNAME>
		<LASTNAME></LASTNAME>
		<EMAIL></EMAIL>
		<TICKETTYPE></TICKETTYPE>
		<TICKETDESCRIPTION></TICKETDESCRIPTION>
		<TICKETSTATUS></TICKETSTATUS>
		<ASSIGNTICKETTO></ASSIGNTICKETTO>
		<ASSIGNTO></ASSIGNTO>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</CREATETICKET>
</VCAREOSS>
</VcareOssApi>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
281	First Name should not be blank.	Please provide First Name as its mandatory.
283	Last Name should not be blank.	Please provide Last Name as its mandatory.
321	Customer not found.	Customer is not found.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
366	Assign to cannot be blank.	Please provide Assign to as it cannot be blank.
378	Assign to is not valid.	Please provide a valid Assign to.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
534	Assign to should be an Active User.	Provide an Active user for Assign to field.
751	Custom message.	This is dynamic message.
775	Telephone number should not be blank.	Provide a valid Telephone number. Telephone number should not be blank.
776	Ticket description should not be blank.	Provide a valid Ticket description. Ticket description should not be blank.
777	Ticket status should not be blank.	Provide a valid Ticket status. Ticket status should not be blank.
778	Ticket status should be Call Back, Closed, Escalation, Open, Pending.	Ticket status should be one of among Call Back, Closed, Escalation, Open, Pending.
783	Assign ticket to should be USER, GROUP.	Enter correct Assign ticket to. Assign ticket to should be USER or GROUP.
784	Assign ticket to should not be blank.	Provide a valid Assign ticket. Assign ticket to should not be blank.
785	First name is not matched with customer.	Enter valid First Name. First name is not matched with customer.
786	Last name not match with customer.	Enter valid Last Name. Last name is not matched with customer.

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>XXXXXXXX</vendorId>
        <referenceNumber>XXXXXXXXX</referenceNumber>
    </credentials>
    <CreateTicket>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>Ticket has been created successfully, Your ticket number is : TKT34</errorDescription>
        <ticketnumber>TKT34</ticketnumber>
    </CreateTicket>
</VcareOssApi>

SUCCESS

<ticketnumber>TKT34</ticketnumber>

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

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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> <CreateTicket> <statusCode>281</statusCode> <description>FAIL</description> <errorDescription>First Name should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: First Name should not be blank.

How to Resolve?: Please provide First Name as its mandatory.

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> <CreateTicket> <statusCode>283</statusCode> <description>FAIL</description> <errorDescription>Last Name should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Last Name should not be blank.

How to Resolve?: Please provide Last Name as its mandatory.

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

Error Description: Customer not found.

How to Resolve?: Customer is not found.

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

Error Description: Agent ID cannot be blank.

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

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> <CreateTicket> <statusCode>366</statusCode> <description>FAIL</description> <errorDescription>Assign to cannot be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Assign to cannot be blank.

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

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> <CreateTicket> <statusCode>378</statusCode> <description>FAIL</description> <errorDescription>Assign to is not valid.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Assign to is not valid.

How to Resolve?: Please provide a valid Assign to.

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

Error Description: Invalid Source.

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

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> <CreateTicket> <statusCode>534</statusCode> <description>FAIL</description> <errorDescription>Assign to should be an Active User.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Assign to should be an Active User.

How to Resolve?: Provide an Active user for Assign to field.

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

Error Description: Custom message.

How to Resolve?: This is dynamic message.

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> <CreateTicket> <statusCode>775</statusCode> <description>FAIL</description> <errorDescription>Telephone number should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Telephone number should not be blank.

How to Resolve?: Provide a valid Telephone number. Telephone number should not be blank.

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> <CreateTicket> <statusCode>776</statusCode> <description>FAIL</description> <errorDescription>Ticket description should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Ticket description should not be blank.

How to Resolve?: Provide a valid Ticket description. Ticket description should not be blank.

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> <CreateTicket> <statusCode>777</statusCode> <description>FAIL</description> <errorDescription>Ticket status should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Ticket status should not be blank.

How to Resolve?: Provide a valid Ticket status. Ticket status should not be blank.

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> <CreateTicket> <statusCode>778</statusCode> <description>FAIL</description> <errorDescription>Ticket status should be Call Back, Closed, Escalation, Open, Pending.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Ticket status should be Call Back, Closed, Escalation, Open, Pending.

How to Resolve?: Ticket status should be one of among Call Back, Closed, Escalation, Open, Pending.

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> <CreateTicket> <statusCode>783</statusCode> <description>FAIL</description> <errorDescription>Assign ticket to should be USER, GROUP.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Assign ticket to should be USER, GROUP.

How to Resolve?: Enter correct Assign ticket to. Assign ticket to should be USER or GROUP.

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> <CreateTicket> <statusCode>784</statusCode> <description>FAIL</description> <errorDescription>Assign ticket to should not be blank.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Assign ticket to should not be blank.

How to Resolve?: Provide a valid Assign ticket. Assign ticket to should not be blank.

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> <CreateTicket> <statusCode>785</statusCode> <description>FAIL</description> <errorDescription>First name is not matched with customer.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: First name is not matched with customer.

How to Resolve?: Enter valid First Name. First name is not matched with customer.

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> <CreateTicket> <statusCode>786</statusCode> <description>FAIL</description> <errorDescription>Last name not match with customer.</errorDescription> </CreateTicket> </VcareOssApi>

Error Description: Last name not match with customer.

How to Resolve?: Enter valid Last Name. Last name is not matched with customer.

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