API Enumerations

This page lists the values in enumerations that are available to configure Wix Answers object statuses and types, and are returned in API responses that contain object structures. Not all values are available to use in all requests, and not all values are available to be returned in all object structures. See the specific API for more details.

Action Type

Action types that can be executed within macros.
Value
Integer Value
Related Parameters
Set ticket labels
101
* labelsActionType (integer): add (1), remove (2), replace (3)
* labelIds (list of label GUIDs)
Set ticket status
102
* status (integer): Ticket status
Assign ticket
103
One of:
* assignedUserId (user GUID)
* assignedGroupId (group GUID)
Add related articles
104
* articleIds (list of article GUIDs)
Add agent reply
105
* content (string)
Add saved reply
106
* savedReplyId (saved reply GUID)
Add reply with article
107
* articleId (article GUID)
* addTicketArticleRelation (Boolean)
Delete ticket
108

Mark as spam
109

Mark as not spam
110

Set ticket priority
111
* priority (integer): Ticket priority
Set ticket locale
112
* locale (two-letter country code string)
Set SLA policy
113
* policyId (SLA policy GUID)
Add internal note
114
* content (string)
* sendAutomatically (Boolean): Default is true.
Set ticket subject
115
* subject (string)
Add CC users
116
* ccRecipients (list of email address objects): CC email addresses, each one a structure of:
  * email (string)
  * name (string)
* toCompanyAccountManager (Boolean): Also add company account manager as CC
* toExecutingAgentManager (Boolean): Also add agent executing this macro as CC
Unassign ticket
117

Set Boolean ticket custom field
121
* name (sting): Field name
* value (Boolean)
Set number ticket custom field
122
* name (sting): Field name
* value (integer)
Set text ticket custom field
123
* name (sting): Field name
* value (text)
Set single select ticket custom field
124
* name (sting): Field name
* value (string)
Set multi-select ticket custom field
125
* name (sting): Field name
* value (list of strings)
Set text ticket custom field by locale
126
* name (sting): Field name
* value (map of locale to string)
* applyValueToAllLocales (Boolean)
Set single select ticket custom field by locale
127
* name (sting): Field name
* value (map of locale to string)
* applyValueToAllLocales (Boolean)
Set Boolean company custom field
131
* name (sting): Field name
* value (Boolean)
Set number company custom field
132
* name (sting): Field name
* value (integer)
Set text company custom field
133
* name (sting): Field name
* value (string)
Set single select company custom field
134
* name (sting): Field name
* value (string)
Set multi-select company custom field
135
* name (sting): Field name
* value (list of strings)
Set Boolean agent custom field (for agent executing this macro)
141
* name (sting): Field name
* value (Boolean)
Set number agent custom field (for agent executing this macro)
142
* name (sting): Field name
* value (integer)
Set text agent custom field (for agent executing this macro)
143
* name (sting): Field name
* value (string)
Set single select agent custom field (for agent executing this macro)
144
* name (sting): Field name
* value (string)
Set multi-select agent custom field (for agent executing this macro)
145
* name (sting): Field name
* value (list of strings)
Send email
201
* emails (list of strings)
* userIds (list of GUIDs)
* groupIds (list of group GUIDs)
* teamRecipientTypes (integer): agents (1), admins (2), all (3)
* toTicketOwner (Boolean)
* toCompanyAccountManager (Boolean)
* emailSubject (string)
* emailContent (string)
Ban user
301

Activity Type

Features, for which tickets originating from this feature can be auto-routed to an agent. Each feature indicates an element related to Wix Answers that an agent might use to interact with a user. These features appear with toggle switches in the user menu in the app.
Value
Integer Value
Notes
Ticketing
10

Call Center
20

Chat
30

Facebook
40

Whatsapp
50

SMS
60

Knowledge Base
70
Used only for filtering agents. Effectively indicates an agent who might work on the Knowledge Base. Not used for auto-assignment.

Agent Channel

Where the agent is currently operating, as it appears in the UI. (This enumeration soon will be replaced by the newer Activity Type.)
Value
Integer Value
Notes
None
0

Ticket
10

Call Center
20

Chat
30

Facebook
40

Whatsapp
50

SMS
60

Agent Status

The visibility status in the UI.
Value
Integer Value
Notes
Online
10

In Work
40

Busy
60

Offline
100

Article Resolution

Value
Integer Value
Notes
Collecting Votes
110
Relevant for feature requests
In Development
112
Relevant for feature requests
Coming Soon
114
Relevant for feature requests
Released
116
Relevant for feature requests
Investigating
120
Relevant for known issues
Working On It
122
Relevant for known issues
Resolved
124
Relevant for known issues
Third-Party Bug
126
Relevant for known issues

Article Status

Value
Integer Value
Notes
Draft
0
A new, unpublished article, or an article whose draft version is different from its most recently published version
Published
10
A published article, whose draft version is the same as the most recently published version
Deleted
30

Article Type

Value
Integer Value
Notes
Article
100

Feature Request
110

Known Issue
120

Video
130

Article Version Publication Status

Value
Integer Value
Notes
Draft
0
One (and only one) draft exists at any one time
Published
1

Authorization Type

Value
Integer Value
Notes
SSO
0

Google
1

Facebook
2

Wix (direct login)
3

Call Participant Status

Value
Integer Value
Notes
Connecting
10
Active participant
Talking
20
Active participant
On Hold
30
Active participant
Muted
40
Active participant
Left
50

Declined
60
Not handled
No Answer
70
Not handled
Cancelled
80
Not handled
Invited
90
Active participant
Failed
100
Not handled

Call Priority

Value
Integer Value
Notes
Normal
0

High
1

Call Status

Value
Integer Value
Group
Notes
In IVR
10
Waiting
An inbound call entered an IVR flow.
In Queue
20
Waiting
A call is waiting in queue and is not reserved.
Reserved
30
Waiting
An agent was reserved to handle a queued call. This status will not last for more than 20 seconds; usually a call is initiated shortly after the agent is reserved.
Initiated
40
In Progress
An agent began an outbound call to a user, or an agent accepted a callback to a user.
Ringing
50
In Progress
The user's phone is now ringing from an outbound call or a callback (see Initiated).
In Progress
60
In Progress
A call is in progress.
Completed
70
Completed
A call ended after at least 20 seconds of being in progress.
Completed in IVR
71
Completed
An inbound call to IVR ended successfully.
Forwarded
72
Completed
The IVR routed an inbound call to a different phone number.

Transferred to Number
73
Completed
An agent transferred a call to a different phone number.
Completed Voicemail
74
Voicemail
A user completed recording a voice message.
Pending Voicemail
75
Voicemail
A user started recording a voice message.
Failed
90
Incomplete
There are multiple reasons why a call may be failed. For example, a service or coverage issue, or a blacklisted number.
No Answer
100
Incomplete
An outbound call or a callback resulted in a busy signal, or was rejected or not answered by the user.
Cancelled
110
Incomplete
There are multiple reasons why a call may be cancelled. One example is when a callback requests to cancel the call after the user cancels a request.
Expired
120
Incomplete
Not in use
Transferred to Queue
130
Incomplete
A call was transferred to a queue.
Abandoned
140
Incomplete
There are multiple reasons why a call may be abandoned. A call was initiated, but not transferred and the call duration was shorter than 20 seconds, for example.
Hung Up in Queue
150
Incomplete
A user hung up while in queue.
Hung Up in IVR
160
Incomplete
A user hung up while in IVR, without indicating that the IVR session was successfully completed.
Transferred to IVR
170

A queue was closed, so the call was transferred to a voicemail IVR layer or an escalation queue.

Call Type

Value
Integer Value
Notes
Inbound
10

Outbound
20

Callback
30

Channel

How a ticket was created.
Value
Integer Value
Channel Data
Web
100
* userFirstName (string)
* userLastName (string)
Email
110
* mailboxID (string)
* mailboxEmail (string)
* attachments (list of URL strings)
Phone Callback
120

Phone Outbound
121

Phone Inbound
122

By Agent
130

Facebook
140
* pageId (string)
* id (string)
* parentId (string)
* postId (string)
* type (integer): Message (10), Post (20)
* time (long)
* attachments (list of URL strings)
Whatsapp
150
* lineId (GUID)
* userPhoneNumber (string)
Chat
160
* chatId (GUID)
* chatStatus (Chat Status)
* chatStatusLastUpdateDate (Unix time string)
* activeParticipantIds (list of GUIDs)
* participantIds (list of GUIDs)
* activeParticipants (list of Agent objects)
* widgetId (GUID)
* unansweredMessageCount (integer)
* originalUserId (GUID)
* lastMessage (Chat Message object)
* waitDurationsSec (list of longs)
* activeDurationsSec (list of longs)
Chat Outbound
161
* chatId (GUID)
* chatStatus (Chat Status)
* chatStatusLastUpdateDate (Unix time string)
* activeParticipantIds (list of GUIDs)
* participantIds (list of GUIDs)
* activeParticipants (list of Agent objects)
* widgetId (GUID)
* unansweredMessageCount (integer)
* originalUserId (GUID)
* lastMessage (Chat Message object)
* waitDurationsSec (list of longs)
* activeDurationsSec (list of longs)
Widget
170
* widgetId (GUID)
API
180

SMS Inbound
190
For future use
SMS Outbound
200
For future use

Chat Message Status

Value
Integer Value
Notes
Queued
10

Failed
20

Sent
30

Delivered
40

Failed
50

Chat Message Type

Value
Integer Value
Notes
User
100

Agent
110

Chat Participant Status

Value
Integer Value
Notes
Talking
10

Left
20

Pending Outbound
30

Chat Status

Value
Integer Value
Notes
Waiting
0

Active
1

Completed
2

Pending Outbound
3

Company Customer Permission

Company customer permission can be set for a user or a company. When set for a user, the setting overrides the company setting for that user.
Value
Integer Value
Notes
Personal Tickets, Only
0
The user(s) can view only their own tickets
All company tickets
1
Can view any company tickets
Company default
2
When set for a user, the user inherits the permission set for the company

Content Task Priority

Value
Integer Value
Notes
Low
10

Normal
20

High
30

Content Task Status

Value
Integer Value
Notes
Open
10

Completed
20

Content Task Type

Value
Integer Value
Notes
Write
10

Update
20

Review
30

Translate
40

Counter Type

Value
Integer Value
Notes
Follower
10

Vote
30

Custom Field Type

Value
Integer Value
Data Type
Notes
Text
1
Text

Multi-Line Text
2
Text

Single Select
3
String

Multi-Select
4
List of strings

Number
5
Number

Checkbox
6
Boolean

Date Picker
7
Date

Email Status

Value
Integer Value
Notes
Not Verified
0

Verified
1

Invalidated
99

Event Type

Value
Integer Value
Item Type
Notes
Article Added
650
Article

Article Updated
651
Article

Article Content Updated
652
Article

Article Deleted
653
Article

Article Restored
654
Article

Article Merged
655
Article

Article Unpublished
656
Article

Article Published
663
Article

Article Labels Updated
665
Article

Article Phrases Updated
666
Article

Article Visibility Changed
667
Article

Ticket Merged to Primary
697
Ticket

Ticket Merged from Secondary
698
Ticket

Ticket Updated
700
Ticket

Ticket Content Updated
701
Ticket

Ticket Deleted
702
Ticket

Ticket Status Changed
703
Ticket

Reply Deleted
705
Reply

Outbound Ticket Added
707
Ticket

Reply Content Updated
709
Reply

Reply Moved
710
Reply

Ticket Created From Reply
711
Ticket

Ticket Labels Updated
712
Ticket

Scheduled Call Cancelled
713
Ticket

Reply Made Into Ticket
714
Reply

Ticket Locale Changed
715
Ticket

Ticket Set Private
716
Ticket

Ticket Article Relations Changed
717
Ticket

Ticket Priority Changed
718
Ticket

Ticket Assigned
722
Ticket

Ticket Unassigned
723
Ticket

Ticket Marked as Spam
724
Ticket

Reply Moved to Ticket
725
Ticket

Reply Moved from Ticket
726
Ticket

Internal Note Deleted
727
Reply

Ticket Custom Fields Updated
728
Ticket

Agent Reply Added
729
Ticket

Ticket Attachments Removed
730
Ticket

Reply Attachments Removed
731
Reply

Rule Failed
732
Ticket

Ticket Transferred
733
Ticket

Email Sent
734
Ticket

Reply Updated on Ticket Transferred
735
Reply

Ticket Authenticated
736
Ticket

SLA Policy Added to Ticket
737
Ticket

Macro Applied on Ticket
738
Ticket

Agent Internal Reply (Note) Added
739
Reply

Ticket Automatically Assigned to Account Manager
740
Ticket

Add Custom Ticket Timeline API
742
Ticket

Ticket Snoozed
745
Ticket

Ticket Unsnoozed
746
Ticket

Ticket Snooze Expired
747
Ticket

CC Users Added to Ticket
750
Ticket

Category Added
800
Category

Category Removed
801
Category

Category Language Values Changed
802
Category

Category Updated
803
Category

Category Moved
804
Category

Chat Ticket User Updated
1500
Ticket

Agent Joined Chat
1501
Ticket

Agent Left Chat
1502
Ticket

Agent Ended Chat
1503
Ticket

User Ended Chat
1506
Ticket

Agent Chat Message Added
1507
Ticket

Ticket Handling Started
2500
Ticket

Ticket Handling Ended
2501
Ticket

All Ticket Handling Ended
2502
Ticket

Item Type

Value
Integer Value
Notes
Category
2

SEO Content
6

Ticket
8

Reply
9

Article
10

Email Template
14

Content Task
40

Mailbox
50

User
60

Saved Reply
70

Label
90

URL Mapping
110

Multilingual Text
120

Saved Filter
130

Phone Call
150

Note
160

Chat Message
170

Chat
175

Integration
180

SLA Policy
190

Group
200

Widget
210

Line
220

Widget Multilingual Texts
221

Company
230

Queue
260

User Role
280

Agent
300

CSAT
320

CSAT Content
330

Rating

Value
Integer Value
Notes
Positive
10

Neutral
20

Negative
30

Reply Status

Value
Integer Value
Notes
Draft
0

Published
1

Deleted
2

Reply Type

Value
Integer Value
Notes
User
100

CC User
101
A reply from the CC: email user
Agent
110

Internal
120
An internal note

Saved Filter Context

Value
Integer Value
Notes
Ticket
0

Chat
10

Saved Filter Type

Value
Integer Value
Notes
System
0
A preset filter that comes with Wix Answers, so technically not relevant for a saved filter.
Private
10

Public
20

Saved Reply Status

Value
Integer Value
Notes
Draft
0

Published
1

Delete
2

Search Type

Value
Integer Value
Notes
Exact
1

Contains
2

Not Contains
3

SLA Policy Status

Value
Integer Value
Notes
Paused
0

Active
1

Completed Successfully
2

Completed Unsuccessfully
3

Ticket Priority

Value
Integer Value
Notes
Low
10

Normal
20

High
30

Ticket Status

Value
Integer Value
Notes
Open
100

Pending
110

Closed
120

Solved
140

Investigating
150

User Type

Value
Integer Value
Notes
Authenticated
1

Unauthenticated
2

Pending Authentication
4

Pending Deletion
5

Deleted
99