CRM API (wapi) Responses

Question

What are the possible responses from the CRM API (wapi)?

Applies To

Contact Center
CRM API (wapi)

Answer

These statuses are within the body of the API Response, The HTTP response status code is 200
'%' represents variables in the response
Please note this list is intended to be a guide and not necessarily an exhaustive list.

Status

status	error_str	Knowledge Base
-1
0
302	XML Data is insufficient or corrupted. Check XML Request	CRM API Wapi Error 302 XML Data Insufficient or Corrupted Check XML Request
302	XML Data is insufficient or corrupted. Unknown Server Error
303	Invalid login parameters.	CRM API (wapi) Error 303 Invalid login parameters
304	Invalid operation %
310	Operation Denied. Not enough permissions	CRM API (wapi) Error 310 Operation Denied. Not enough permissions
302	XML Data is insufficient or corrupted. Unknown Server Error
500	Internal Server Error
503	Service Unavailable

Error Codes

ERROR_CODE	ERROR_STR	Error Definition (From the CRM API User Guide)	Knowledge Base
1	Not a valid XML string.	The XML string is not valid.
2	The passed value '%s' of the alias %s doesn't meet the specified criterion	The tag is not a valid action for the object type selected.	CRM API Modify Email to Null Gets Error
3	The length of the value for the alias %s doesn't conform to the criterion. The length of the value passed is %d, min length allowed is %d and max length allowed is %d	Length mismatch; consult documentation.
4	Regular expression not allowed for the alias %s	Some tag values can be passed with % for the GET action. Other tag values cannot be passed.
5	The value '%s' of the tag '%s' is not valid	The XML string is not correct.
6	The tag '%s' not passed
7	No tags found
8	None of the possible mandatory tags or its values are found. Please check the documentation and pass at least one mandatory tag	A mandatory tag is not passed
9	The value of mandatory tag %s is empty
10	The mandatory tag %s not passed
11	The STATUS of the tag %s is 'DEL'. No action allowed on this tag
12	The length of the value of the tag %s is %d which is greater than the allowed value %d	The custom field length exceeds the maximum value.
13	The value of the passed alias %s is not in the correct format (mmddyyyy)
14	The value '%s' of the alias '%s' is not valid	The value passed for TagName is not valid
15	OBJECT '%s' is not a valid object	The value of the object in the XML string is not valid.
16	OBJECT value not passed	In the XML string passed, there is no object value.
17	Action value not valid	The action value in the XML string is not valid
18	Action '%s' Not Valid for the Object %s	The action value for the given object is not valid.
19	ACTION value not passed	The action value is not passed in the XML string.
20	OBJECT name '%s' not valid	The object name is not valid.
21	The tag '%s' is not a valid tag for the %s action on the %s object	The custom field status is deleted.
22	Duplicate Tag: %s	Duplicate tags are passed for the ADD, MODIFY, or DELETE actions.
23	Input Error. Illegal character %c
50	The status of the value '%s' of the ASSIGNEDTO tag is deleted	The value passed for ASSIGNEDTO is deleted.
51	TAGS Incompatible. ASSIGNEDTO passed with STATUS = Unassigned	A case cannot be assigned to an agent when the status of the case is Unassigned.
52	TAGS Incompatible. EMPTY ASSIGNEDTO passed with STATUS = OPEN	A case must be assigned to an agent if the status is Open.
53	TAGS Incompatible. ASSIGNEDTO passed but no STATUS is passed. By default STATUS value is label with USABILITY ='UNA'	Must pass the ASSIGNEDTO and STATUS parameters. By default, the status is set to Unassigned.
54	TAGS Incompatible. The usability of status is OPN, but no ASSIGNEDTO passed	The ASSIGNEDTO parameter needs to be passed in XML string.
55	TAGS Incompatible. ASSIGNEDTO passed but STATUS is UNASSIGNED	The ASSIGNEDTO parameter passed, but the status is set to Unassigned.
56	TAGS Incompatible. The usability of STATUS cannot be UNA, when the Case is assigned to some agent	The status of the case is changed to Unassigned without passing ASSIGNEDTO tag.
57	TAGS Incompatible. The USABILITY of STATUS cannot be OPN, when the Case is not assigned to some agent	The status of a case cannot be Open when the case is not assigned to an agent. In addition, it is possible that the ASSIGNEDTO tag was not passed.
58	CASENUM %s is an EMAIL Case. The Description of an Email Case cannot be modified	A case is created via an email to tenant. The description of email cases cannot be modified.
59	The ALIAS 'AUTOPASSWD' is not given	The AUTOPASSWD tag is not passed in the ADD customer request.
60	Inconsistent tags. AUTOPASSWORD is TRUE and PASSWORD is also provided	A password is automatically generated, and therefore, there is a conflict when the password is also provided.
61	The ALIAS 'AUTOPASSWD' is FALSE, but ALIAS 'PASSWORD' is not provided	If AUTOPASSWORD is false,the alias PASSWORD must be provided.
62	TAGS Incompatible. The value of STATUS cannot be Unassigned, when the Case is assigned to some agent	The status cannot be Unassigned when the case is assigned to an agent.
63	REMINDER tag cannot be used without DUEDATE tag
70	FAQCATID not passed	An FAQ category is deleted and the FAQCATID tag is not passed.
71	Faq Category cannot be deleted when FAQ exists for the given category	An FAQ category cannot be deleted when an FAQ exists in the given category.
80	The passed caseId %d is not valid	The value passed for the given alias does not meet the specified criteria.
81	Duplicate value '%s' of '%s'	The value inserted must be unique and the value passed already exists in the database.
82	The email address '%s' is already being used by another customer
83	The passed contactId %d is not valid
84	The value '%s' of the tag '%s' must be unique		CRM API (wapi) Error 84 Internal error
85	The passed taskId %d is not valid

Internal Error

Error codes greater than 1000 are Internal error

1001, 1002, 1003, 1004, 1005, 1006, 1007, 1008, 1009 1010, 1011, 1012, 1013, 1014, 1015, 1016, 1017, 1018, 1019, 1020, 1021, 1022, 1023, 1024, 1025, 1026, 1027, 1028, 1100, 1101, 1102, 1103, 1104, 1105, 1106, 1107, 1108, 1109, 1110, 1111, 1112, 1113, 1114, 1115, 1116, 1117, 1118
CRM API WAPI 1100 Internal Error

Additional Information

CRM API User Guide

Example Response

<?xml version="1.0" encoding="ISO-8859-1"?>
<WAPI>
    <REPLY STATUS="0" ERROR_STR="" ERROR_CODE="0">
        <ACCOUNTNUM>10000505</ACCOUNTNUM>
    </REPLY>
</WAPI>