Handles communication between Staff and Users
- getTicket
- createHistory
- createTicket
- getCustomForm
- submitCustomForm
- getParticipantsInsideVideoRoom
- getTokenForVideoRoom
Get Ticket with the specific id
applicationClient.lead.getTicket(id: id) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| id | String | yes | ID of ticket to be retrieved |
Get Ticket with the specific id, this is used to view the ticket details
Returned Response:
Success
Examples:
Default
{
"value": {
"context": {
"application_id": "000000000000000000000003",
"company_id": "884"
},
"content": {
"title": "Tickets",
"description": "Tickets Data",
"attachments": []
},
"status": {
"display": "In Progress",
"color": "#ffa951",
"key": "in_progress"
},
"priority": {
"display": "Medium",
"color": "#f37736",
"key": "medium"
},
"assigned_to": {
"agent_id": "5d1363adf599d850df93175e",
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
},
"tags": [
"some-title"
],
"_id": "6012f38557751ee8fc162cf7",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "88.0.4324.96"
},
"os": {
"name": "macOS",
"version": "10.15.7",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"source": "sales_channel",
"created_by": {
"id": "5d1363adf599d850df93175e",
"user": {
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
}
},
"response_id": "6012f38457751e0fb8162cf6",
"category": {
"form": {
"login_required": false,
"should_notify": false,
"inputs": [
{
"required": false,
"type": "text",
"enum": [],
"display": "Single lineeee",
"key": "single-lineeee",
"showRegexInput": false
},
{
"required": false,
"type": "email",
"enum": [],
"display": "Email",
"regex": "\\S+@\\S+\\.\\S+",
"key": "email",
"showRegexInput": true
},
{
"required": false,
"type": "text",
"enum": [],
"display": "dfsdf",
"key": "dfsdf",
"showRegexInput": false
}
],
"available_assignees": [
"5b9b98150df588546aaea6d2",
"5c45d78395d7504f76c2cb37"
],
"_id": "5fd72db3dc250f8decfc61b2",
"title": "SOme title",
"description": "SOme big description",
"slug": "some-title",
"application_id": "000000000000000000000003",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "87.0.4280.88"
},
"os": {
"name": "macOS",
"version": "10.15.6",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"created_by": "5d1363adf599d850df93175e",
"createdAt": "2020-12-14T09:17:39.953Z",
"updatedAt": "2021-01-28T18:48:07.717Z",
"__v": 0
},
"key": "some-title",
"display": "SOme title"
},
"ticket_id": "43",
"createdAt": "2021-01-28T17:25:25.013Z",
"updatedAt": "2021-01-28T17:25:33.396Z",
"__v": 0,
"video_room_id": "6012f38557751ee8fc162cf7"
}
}Create history for specific Ticket
applicationClient.lead.createHistory(id: id, body: body) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| id | String | yes | Ticket ID for which history is created |
| body | TicketHistoryPayload | yes | Request body |
Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating.
Returned Response:
Success
Examples:
Default
{
"value": {
"_id": "601a9d52c26687d086c499ef",
"ticket_id": "41",
"type": "comment",
"value": {
"text": "d",
"media": []
},
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "88.0.4324.96"
},
"os": {
"name": "macOS",
"version": "10.15.7",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"created_by": {},
"createdAt": "2021-02-03T12:55:46.808Z",
"updatedAt": "2021-02-03T12:55:46.808Z",
"__v": 0
}
}Create Ticket
applicationClient.lead.createTicket(body: body) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| body | AddTicketPayload | yes | Request body |
This is used to Create Ticket.
Returned Response:
Success
Examples:
Default
{
"value": {
"context": {
"application_id": "000000000000000000000003",
"company_id": "884"
},
"content": {
"title": "Some title Response",
"description": "description",
"attachments": []
},
"status": {
"display": "In Progress",
"color": "#ffa951",
"key": "in_progress"
},
"priority": {
"display": "Medium",
"color": "#f37736",
"key": "medium"
},
"assigned_to": {
"agent_id": "5d1363adf599d850df93175e",
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
},
"tags": [
"some-title"
],
"_id": "6012f38557751ee8fc162cf7",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "88.0.4324.96"
},
"os": {
"name": "macOS",
"version": "10.15.7",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"source": "sales_channel",
"created_by": {
"id": "5d1363adf599d850df93175e",
"user": {
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
}
},
"response_id": "6012f38457751e0fb8162cf6",
"category": {
"form": {
"login_required": false,
"should_notify": false,
"inputs": [
{
"required": false,
"type": "text",
"enum": [],
"display": "Single lineeee",
"key": "single-lineeee",
"showRegexInput": false
},
{
"required": false,
"type": "email",
"enum": [],
"display": "Email",
"regex": "\\S+@\\S+\\.\\S+",
"key": "email",
"showRegexInput": true
},
{
"required": false,
"type": "text",
"enum": [],
"display": "dfsdf",
"key": "dfsdf",
"showRegexInput": false
}
],
"available_assignees": [
"5b9b98150df588546aaea6d2",
"5c45d78395d7504f76c2cb37"
],
"_id": "5fd72db3dc250f8decfc61b2",
"title": "SOme title",
"description": "SOme big description",
"slug": "some-title",
"application_id": "000000000000000000000003",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "87.0.4280.88"
},
"os": {
"name": "macOS",
"version": "10.15.6",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"created_by": "5d1363adf599d850df93175e",
"createdAt": "2020-12-14T09:17:39.953Z",
"updatedAt": "2021-01-28T18:48:07.717Z",
"__v": 0
},
"key": "some-title",
"display": "SOme title"
},
"ticket_id": "43",
"createdAt": "2021-01-28T17:25:25.013Z",
"updatedAt": "2021-01-28T17:25:33.396Z",
"__v": 0,
"video_room_id": "6012f38557751ee8fc162cf7"
}
}Get specific Custom Form using it's slug
applicationClient.lead.getCustomForm(slug: slug) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| slug | String | yes | Slug of form whose response is getting submitted |
Get specific Custom Form using it's slug, this is used to view the form.
Returned Response:
Success
Examples:
Default
{
"value": {
"priority": "high",
"login_required": false,
"should_notify": false,
"inputs": [
{
"required": false,
"type": "text",
"display": "Name",
"placeholder": "Please enter your name",
"key": "name"
}
],
"available_assignees": [],
"_id": "5fd258a9088f957f34c288fc",
"title": "trail form",
"description": "Trail form description",
"slug": "trail-form",
"application_id": "000000000000000000000003",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "87.0.4280.88"
},
"os": {
"name": "macOS",
"version": "10.15.6",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"created_by": "5d1363adf599d850df93175e",
"createdAt": "2020-12-10T17:19:37.515Z",
"updatedAt": "2020-12-10T17:19:43.214Z",
"__v": 0
}
}Submit Response for a specific Custom Form using it's slug
applicationClient.lead.submitCustomForm(slug: slug, body: body) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| slug | String | yes | Slug of form whose response is getting submitted |
| body | CustomFormSubmissionPayload | yes | Request body |
Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
Returned Response:
Success
Examples:
Default
{
"value": {
"ticket": {
"context": {
"application_id": "000000000000000000000003",
"company_id": "884"
},
"content": {
"title": "Some title Response",
"description": "description",
"attachments": []
},
"status": {
"display": "In Progress",
"color": "#ffa951",
"key": "in_progress"
},
"priority": {
"display": "Medium",
"color": "#f37736",
"key": "medium"
},
"assigned_to": {
"agent_id": "5d1363adf599d850df93175e",
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
},
"tags": [
"some-title"
],
"_id": "6012f38557751ee8fc162cf7",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.96 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "88.0.4324.96"
},
"os": {
"name": "macOS",
"version": "10.15.7",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"source": "sales_channel",
"created_by": {
"id": "5d1363adf599d850df93175e",
"user": {
"gender": "male",
"accountType": "user",
"active": true,
"profilePicUrl": "https://platform-lookaside.fbsbx.com/platform/profilepic/?asid=2136700473091190&height=400&width=400&ext=1554542761&hash=AeS6cuWIdjDdJJ-b",
"hasOldPasswordHash": false,
"_id": "5d1363adf599d850df93175e",
"phoneNumbers": [
{
"active": true,
"primary": true,
"verified": true,
"countryCode": 91,
"phone": "9999999999"
}
],
"firstName": "Nikhil",
"lastName": "Manapure",
"emails": [
{
"active": true,
"primary": true,
"verified": true,
"email": "[email protected]"
}
],
"username": "niktest_xyz_com_38425_20500281",
"createdAt": "2019-01-01T17:22:38.528Z",
"updatedAt": "2021-01-22T10:02:42.258Z",
"uid": "20500281",
"__v": 56
}
},
"response_id": "6012f38457751e0fb8162cf6",
"category": {
"form": {
"login_required": false,
"should_notify": false,
"inputs": [
{
"required": false,
"type": "text",
"enum": [],
"display": "Single lineeee",
"key": "single-lineeee",
"showRegexInput": false
},
{
"required": false,
"type": "email",
"enum": [],
"display": "Email",
"regex": "\\S+@\\S+\\.\\S+",
"key": "email",
"showRegexInput": true
},
{
"required": false,
"type": "text",
"enum": [],
"display": "dfsdf",
"key": "dfsdf",
"showRegexInput": false
}
],
"available_assignees": [
"5b9b98150df588546aaea6d2",
"5c45d78395d7504f76c2cb37"
],
"_id": "5fd72db3dc250f8decfc61b2",
"title": "SOme title",
"description": "SOme big description",
"slug": "some-title",
"application_id": "000000000000000000000003",
"created_on": {
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
"platform": "web",
"meta": {
"browser": {
"name": "Chrome",
"version": "87.0.4280.88"
},
"os": {
"name": "macOS",
"version": "10.15.6",
"versionName": "Catalina"
},
"platform": {
"type": "desktop",
"vendor": "Apple"
},
"engine": {
"name": "Blink"
}
}
},
"created_by": "5d1363adf599d850df93175e",
"createdAt": "2020-12-14T09:17:39.953Z",
"updatedAt": "2021-01-28T18:48:07.717Z",
"__v": 0
},
"key": "some-title",
"display": "SOme title"
},
"ticket_id": "43",
"createdAt": "2021-01-28T17:25:25.013Z",
"updatedAt": "2021-01-28T17:25:33.396Z",
"__v": 0,
"video_room_id": "6012f38557751ee8fc162cf7"
}
}
}Get participants of a specific Video Room using it's unique name
applicationClient.lead.getParticipantsInsideVideoRoom(uniqueName: uniqueName) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| uniqueName | String | yes | Unique name of Video Room |
Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
Returned Response:
GetParticipantsInsideVideoRoomResponse
Success
Examples:
Default
{
"value": {
"participants": []
}
}Get Token to join a specific Video Room using it's unqiue name
applicationClient.lead.getTokenForVideoRoom(uniqueName: uniqueName) { (response, error) in
// Use response
}| Argument | Type | Required | Description |
|---|---|---|---|
| uniqueName | String | yes | Unique name of Video Room |
Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
Returned Response:
Success
Examples:
Default
{
"value": {
"access_token": "your_token_to_the_room"
}
}| Properties | Type | Nullable | Description |
|---|---|---|---|
| value | [String: Any] | no | Details of history event |
| type | HistoryTypeEnum | no |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| response | [[String: Any]] | no | Form response |
| attachments | [TicketAsset]? | yes | List of all attachments related to the form |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| accessToken | String | no | Access token to be used for video room |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| participants | [Participant] | no | List of participants of the video room |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| user | UserSchema? | yes | |
| identity | String? | yes | Unique identifier of participant |
| status | String? | yes | Status of participant |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| firstName | String? | yes | First name |
| lastName | String? | yes | Last name |
| phoneNumbers | [PhoneNumber]? | yes | List of phone numbers |
| emails | [Email]? | yes | List of email addresses |
| gender | String? | yes | Gender of user |
| active | Bool? | yes | Is account active |
| profilePicUrl | String? | yes | URL for profile pic |
| username | String? | yes | username of user |
| accountType | String? | yes | Type of account |
| uid | String? | yes | Unique identifier of user |
| debug | Debug? | yes | |
| hasOldPasswordHash | Bool? | yes | Denotes if user has old password hash |
| id | String? | yes | Unique identifier of user |
| createdAt | String? | yes | Time of user creation |
| updatedAt | String? | yes | Last time of user details update |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| active | Bool? | yes | Denotes if the phone number is active |
| primary | Bool? | yes | Denotes it's the primary phone number for the account |
| verified | Bool? | yes | Denotes it's a verified phone number |
| phone | String? | yes | Phone number |
| countryCode | Int? | yes | Country code |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| primary | Bool? | yes | Denotes it's the primary email for the account |
| verified | Bool? | yes | Denotes it's a verified email |
| String? | yes | Email Address | |
| active | Bool? | yes | Denotes if the email is active |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| source | String? | yes | Source of user |
| platform | String? | yes | Platform of user |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| message | String | no | Success message for form submission |
| ticket | Ticket? | yes |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| applicationId | String? | yes | Application ID related to the ticket |
| companyId | String | no | Company ID related to the ticket |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| userAgent | String | no | Useragent details |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| display | String? | yes | Display text for asset |
| value | String | no | To be used for details |
| type | TicketAssetTypeEnum | no |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| title | String | no | Title for ticket |
| description | String? | yes | Long description of issue |
| attachments | [TicketAsset]? | yes | List of all attachments related to the ticket |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| createdBy | [String: Any]? | yes | Creator of the ticket |
| status | String? | yes | Status of the ticket |
| priority | PriorityEnum? | yes | |
| category | String | no | Category of the ticket |
| content | TicketContent | no | |
| customJson | [String: Any]? | yes | optional custom data that needs to be sent |
| subscribers | [String]? | yes |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| key | PriorityEnum | no | |
| display | String | no | Display text for priority |
| color | String | no | Color for priority |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| key | String | no | Key for status |
| display | String | no | Display text for status |
| color | String | no | Color for status |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| title | String | no | Title for submit button |
| titleColor | String | no | Title color submit button |
| backgroundColor | String | no | Color for submit button |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| duration | Double | no | Duration for polling of staff |
| message | String | no | Message for polling |
| successMessage | String | no | Message for successful polling |
| failureMessage | String | no | Message if polling failed |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| applicationId | String | no | Application ID for form |
| slug | String | no | Slug for the form, which is to be used for accessing the form |
| headerImage | String? | yes | Form header image that will be shown to the user |
| title | String | no | Form title that will be shown to the user |
| description | String? | yes | Form description that will be shown to the user |
| priority | Priority | no | |
| loginRequired | Bool | no | Denotes if login is required to make a form response submission |
| shouldNotify | Bool | no | Denotes if new response submission for the form should be notified to the assignees |
| successMessage | String? | yes | Message that is to be shown on succesfull form response submission |
| submitButton | SubmitButton? | yes | |
| inputs | [[String: Any]] | no | List of all the form fields |
| createdOn | CreatedOn? | yes | |
| pollForAssignment | PollForAssignment? | yes | |
| id | String | no | Unique identifier for the form |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| inputs | [String: Any]? | yes | Input details for the feed back form |
| title | String? | yes | Title for the feed back form |
| timestamps | [String: Any]? | yes | Gives details of category releted data |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| display | String | no | Category display value identifier |
| key | String | no | Category key value identifier |
| subCategories | TicketCategory? | yes | |
| groupId | Double? | yes | Group id of category releted data |
| feedbackForm | FeedbackForm? | yes |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| type | String | no | Type of the history event |
| value | [String: Any] | no | Data of the history event |
| ticketId | String | no | Readable ticket number |
| createdOn | CreatedOn? | yes | |
| createdBy | [String: Any]? | yes | User who created the history event |
| id | String | no | Unique identifier of the history event |
| updatedAt | String? | yes | Time of last update of the history event |
| createdAt | String? | yes | Time of creation of the history event |
| Properties | Type | Nullable | Description |
|---|---|---|---|
| context | TicketContext? | yes | |
| createdOn | CreatedOn? | yes | |
| responseId | String? | yes | Details of company and application realated to the ticket |
| content | TicketContent? | yes | |
| category | TicketCategory | no | |
| subCategory | String? | yes | Sub-category assigned to the ticket |
| source | TicketSourceEnum | no | |
| status | Status | no | |
| priority | Priority | no | |
| createdBy | [String: Any]? | yes | User details of ticket creator |
| assignedTo | [String: Any]? | yes | Details of support staff to whom ticket is assigned |
| tags | [String]? | yes | Tags relevant to ticket |
| customJson | [String: Any]? | yes | custom json relevant to the ticket |
| isFeedbackPending | Bool? | yes | Denotes if feedback submission is pending for the ticket |
| integration | [String: Any]? | yes | Integration type and its details of the ticket |
| id | String | no | Unique identifier for the ticket |
| updatedAt | String? | yes | Time when the ticket was last updated |
| createdAt | String? | yes | Time when the ticket was created |
Type : string
| Name | Value | Description |
|---|---|---|
| low | low | This means ticket is low priority |
| medium | medium | This means ticket is medium priority |
| high | high | This means ticket is high priority |
| urgent | urgent | This means ticket is of urgent priority |
Type : string
| Name | Value | Description |
|---|---|---|
| rating | rating | This means history event is a rating |
| log | log | This means history event is a changelog |
| comment | comment | This means history event is a comment |
| thread | thread | This means history event is a thread |
Type : string
| Name | Value | Description |
|---|---|---|
| image | image | Denotes asset is of image type |
| video | video | Denotes asset is of video type |
| file | file | Denotes asset is of file type |
| youtube | youtube | Denotes asset is an youtube link |
| product | product | Denotes asset is of product type |
| collection | collection | Denotes asset is of collection type |
| brand | brand | Denotes asset is of brand type |
| shipment | shipment | Denotes asset is of shipment type |
| order | order | Denotes asset is of order type |
Type : string
| Name | Value | Description |
|---|---|---|
| platformPanel | platform_panel | This means it is company level ticket |
| salesChannel | sales_channel | This means it is a application/sales channel level ticket |