{ "openapi": "3.0.1", "info": { "title": "Infoset REST API", "description": "Infoset REST API allows you to automate processes and integrate Infoset with other products and services.", "termsOfService": "https://infoset.app/terms-of-use", "contact": { "name": "Infoset", "url": "https://infoset.app/" }, "version": "v1" }, "paths": { "/v1/announcements/{id}": { "get": { "tags": [ "Announcement" ], "summary": "Get details of a announcement", "parameters": [ { "name": "id", "in": "path", "description": "Announcement identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcement" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Announcement" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Announcement" ], "summary": "Delete announcement", "parameters": [ { "name": "id", "in": "path", "description": "Announcement identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/announcements": { "get": { "tags": [ "Announcement" ], "summary": "List all existing announcements", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IsRead", "in": "query", "schema": { "type": "boolean" } }, { "name": "Status", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsAll", "in": "query", "schema": { "type": "boolean" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "MessageType", "in": "query", "schema": { "type": "string" } }, { "name": "SendType", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Announcement" ], "summary": "Create announcement", "requestBody": { "description": "Announcement data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Announcement" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Announcement" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Announcement" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Announcement" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/announcements/{id}/logs": { "get": { "tags": [ "Announcement" ], "summary": "List all read logs of announcement", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "returnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementReadLogQueryResult" } } } } } } }, "/v1/announcements/{id}/read": { "post": { "tags": [ "Announcement" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementReadResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/auditlogs": { "get": { "tags": [ "AuditLog" ], "summary": "List all audit logs", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "Nickname", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/AuditLogType" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "Event", "in": "query", "schema": { "type": "string" } }, { "name": "ActorType", "in": "query", "schema": { "type": "string" } }, { "name": "TargetType", "in": "query", "schema": { "type": "string" } }, { "name": "RecordId", "in": "query", "schema": { "type": "string" } }, { "name": "RecordName", "in": "query", "schema": { "type": "string" } }, { "name": "Result", "in": "query", "schema": { "type": "string" } }, { "name": "RetentionClass", "in": "query", "schema": { "type": "string" } }, { "name": "Source", "in": "query", "schema": { "type": "string" } }, { "name": "CorrelationId", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditLogResponseModelQueryResult" } } } } } } }, "/v1/automations/{id}": { "get": { "tags": [ "Automation" ], "summary": "Get details of an automation.", "parameters": [ { "name": "id", "in": "path", "description": "automation identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Automation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Automation" ], "summary": "Update automation", "parameters": [ { "name": "id", "in": "path", "description": "Automation identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Automation data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Automation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Automation" ], "summary": "Delete automation", "parameters": [ { "name": "id", "in": "path", "description": "Automation identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Automation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/automations/{id}/logs": { "get": { "tags": [ "Automation" ], "summary": "Get execution logs of an automation.", "parameters": [ { "name": "id", "in": "path", "description": "automation identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/automations": { "get": { "tags": [ "Automation" ], "summary": "List all existing automations", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Description", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "EventType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ActionEventType" } }, { "name": "TimeBased", "in": "query", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationDataQueryResult" } } } } } }, "post": { "tags": [ "Automation" ], "summary": "Saves an automation.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Automation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Automation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Automation" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Automation" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Automation" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/transfernumber": { "put": { "tags": [ "CallCenter" ], "summary": "Transfers the call to the target number", "parameters": [ { "name": "sourceNumber", "in": "query", "schema": { "type": "string" } }, { "name": "destinationNumber", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/dialnumber": { "put": { "tags": [ "CallCenter" ], "summary": "Direct dial number (Click to call)", "parameters": [ { "name": "sourceNumber", "in": "query", "description": "Extension of the caller VoIP user (e.g. 1001)", "schema": { "type": "string" } }, { "name": "destinationNumber", "in": "query", "description": "Phone number to call (extension, mobile number etc., e.g. 1002 or 15554443322)", "schema": { "type": "string" } }, { "name": "externalNumber", "in": "query", "description": "Extension of the virtual service provider to make the call from (e.g. 7000)", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of called number (e.g Contact or Company)

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "id", "in": "query", "description": "Id of called type (e.g ContactId or CompanyId)", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/dialdirectnumber": { "put": { "tags": [ "CallCenter" ], "summary": "Calls the destination number directly with the specified parameters.", "parameters": [ { "name": "dialedNumber", "in": "query", "description": "The destination phone number to dial.", "schema": { "type": "string" } }, { "name": "callEndNumber", "in": "query", "description": "Number info where the call will end (e.g. agent, ivr, callcenter queue etc.)", "schema": { "type": "string" } }, { "name": "externalNumber", "in": "query", "description": "Extension of the virtual service provider to make the call from (e.g. 7000)", "schema": { "type": "string" } }, { "name": "webhookUrl", "in": "query", "description": "The URL of the webhook to send the call result to. The calling service sends an HTTP request to this URL when the call operation is completed.", "schema": { "type": "string" } }, { "name": "maxRingTimeSec", "in": "query", "description": "The maximum ring time in seconds.", "schema": { "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/endcallsession": { "put": { "tags": [ "CallCenter" ], "summary": "End call session", "parameters": [ { "name": "callSessionId", "in": "query", "description": "Active call session ID info.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/calllogs": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing call logs", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CallerName", "in": "query", "schema": { "type": "string" } }, { "name": "CallerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "CalledName", "in": "query", "schema": { "type": "string" } }, { "name": "CalledNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Dtmf", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "CallDirection", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallDirectionType" } }, { "name": "RecordStatus", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SourceType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallSourceType" } }, { "name": "SourceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DestinationType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallDestinationType" } }, { "name": "DestinationId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "EventType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallStatus" } }, { "name": "HasRecording", "in": "query", "schema": { "type": "boolean" } }, { "name": "TagIds", "in": "query", "schema": { "type": "string" } }, { "name": "MinUserRatingScore", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxUserRatingScore", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MinCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogQueryResult" } } } } } } }, "/v1/callcenter/calllogs/{id}/tags": { "put": { "tags": [ "CallCenter" ], "summary": "Edit call log tags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditCallLogTagRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditCallLogTagRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditCallLogTagRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditCallLogTagRequestModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogQueryResult" } } } } } } }, "/v1/callcenter/calllogs/download": { "get": { "tags": [ "CallCenter" ], "summary": "", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CallerName", "in": "query", "schema": { "type": "string" } }, { "name": "CallerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "CalledName", "in": "query", "schema": { "type": "string" } }, { "name": "CalledNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Dtmf", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "CallDirection", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallDirectionType" } }, { "name": "RecordStatus", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SourceType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallSourceType" } }, { "name": "SourceId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DestinationType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallDestinationType" } }, { "name": "DestinationId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "EventType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/CallStatus" } }, { "name": "HasRecording", "in": "query", "schema": { "type": "boolean" } }, { "name": "TagIds", "in": "query", "schema": { "type": "string" } }, { "name": "MinUserRatingScore", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxUserRatingScore", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MinCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "400": { "description": "Bad Request", "headers": { "X-RateLimit-Limit": { "description": "The maximum number of requests available in the current time frame.", "schema": { "type": "integer", "description": "The maximum number of requests available in the current time frame." }, "example": 100 }, "X-RateLimit-Remaining": { "description": "The number of remaining requests in the current time frame.", "schema": { "type": "integer", "description": "The number of remaining requests in the current time frame." }, "example": 80 }, "X-RateLimit-Reset": { "description": "The remaining seconds before the rate limit resets.", "schema": { "type": "integer", "description": "The remaining seconds before the rate limit resets." }, "example": 3600 } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/calllogs/{id}/download": { "post": { "tags": [ "CallCenter" ], "summary": "Create token to download the voice recording", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "get": { "tags": [ "CallCenter" ], "summary": "You can download the voice recording of a call log", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/calllogs/{id}/play": { "post": { "tags": [ "CallCenter" ], "summary": "Create token to listen to the voice recording", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "get": { "tags": [ "CallCenter" ], "summary": "Play the voice recording of a call", "parameters": [ { "name": "id", "in": "path", "description": "Call log identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/calllogs/{id}": { "delete": { "tags": [ "CallCenter" ], "summary": "Deletes the call recording of the call", "parameters": [ { "name": "id", "in": "path", "description": "Call log identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voicemails": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing voice mails", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ListenStatus", "in": "query", "schema": { "type": "boolean" } }, { "name": "VoipUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ListenUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CallerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "CalledNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Dtmf", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "description": "Datetime format 'yyyy-MM-ddT HH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "Datetime format 'yyyy-MM-ddT HH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoicemailQueryResult" } } } } } } }, "/v1/callcenter/voicemails/{id}/token": { "post": { "tags": [ "CallCenter" ], "summary": "Create token to listen to and download the voicemail recording", "parameters": [ { "name": "id", "in": "path", "description": "Voice mail identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voicemails/{id}/download": { "get": { "tags": [ "CallCenter" ], "summary": "You can download the voice mail recording", "parameters": [ { "name": "id", "in": "path", "description": "Voice mail identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "query", "description": "Token identifier", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voicemails/{id}/play": { "get": { "tags": [ "CallCenter" ], "summary": "You can play the voice mail recording of a call", "parameters": [ { "name": "id", "in": "path", "description": "Call log identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "token", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voicemails/{id}": { "delete": { "tags": [ "CallCenter" ], "summary": "Deletes the voicemail of the call", "parameters": [ { "name": "id", "in": "path", "description": "Voicemail identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Voicemail" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voipusers/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a single voip user", "parameters": [ { "name": "id", "in": "path", "description": "Voip User identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update voip user", "parameters": [ { "name": "id", "in": "path", "description": "Voip user identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Voip user data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete voip user", "parameters": [ { "name": "id", "in": "path", "description": "Voip user identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voipusers": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing voip users", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "UserName", "in": "query", "schema": { "type": "string" } }, { "name": "ExtNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Owner", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "description": "Datetime format 'yyyy-MM-ddT HH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "Datetime format 'yyyy-MM-ddT HH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipUserResponseModelQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create VoIP user", "requestBody": { "description": "Voip user data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VoipUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VoipUser" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/voipusers/insertbulk": { "post": { "tags": [ "CallCenter" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoipUser" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoipUser" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoipUser" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoipUser" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/providers/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a single voip provider", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update voip provider", "parameters": [ { "name": "id", "in": "path", "description": "Voip provider identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Voip provider data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete voip provider", "parameters": [ { "name": "id", "in": "path", "description": "Voip provider identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/providers": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing voip providers", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "VirtualExtNumber", "in": "query", "schema": { "type": "string" } }, { "name": "ExternalNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipProviderResponseModelQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create VoIP provider", "requestBody": { "description": "Voip provider data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipProvider" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/queues/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a single callcenter queue", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update Call Center queue", "parameters": [ { "name": "id", "in": "path", "description": "Call Center queue identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Call Center queue data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete callcenter queue", "parameters": [ { "name": "id", "in": "path", "description": "Callcenter queue identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/queues": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing callcenter queues", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "VirtualExtNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueueResponseModelQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create call center queue", "requestBody": { "description": "Call Center queue data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallCenterQueue" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/ivrmenus/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a ivr menu", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update ivr menu", "parameters": [ { "name": "id", "in": "path", "description": "Ivr menu identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Ivr menu data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete ivr menu", "parameters": [ { "name": "id", "in": "path", "description": "Ivr menu identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/ivrmenus": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing ivr menus", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "VirtualExtNumber", "in": "query", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenuQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create IVR menu", "requestBody": { "description": "Ivr menu data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/ivrdetailmenus/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a ivr detail menu", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update ivr detail menu", "parameters": [ { "name": "id", "in": "path", "description": "Ivr detail menu identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Ivr detail menu data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete ivr detail menu", "parameters": [ { "name": "id", "in": "path", "description": "Ivr detail menu identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/ivrdetailmenus": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing ivr detail menus", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IVRMenuId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Number", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenuQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create IVR detail menu", "requestBody": { "description": "Ivr detail menu data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IVRDetailMenu" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/dialplans/{id}": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a dial plan", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update dial plan", "parameters": [ { "name": "id", "in": "path", "description": "dial Plan identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Dial Plan data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete dial plan", "parameters": [ { "name": "id", "in": "path", "description": "Dial plan identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/dialplans": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing dial plans", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "SourceVirtualNumber", "in": "query", "schema": { "type": "string" } }, { "name": "DestinationVirtualNumber", "in": "query", "schema": { "type": "string" } }, { "name": "DidMask", "in": "query", "schema": { "type": "string" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialPlanQueryResult" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Create dial plan", "requestBody": { "description": "Dial Plan data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DialPlan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DialPlan" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialPlan" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/folders": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing audio file folders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioFileFolderQueryResult" } } } } } } }, "/v1/callcenter/audiofiles": { "get": { "tags": [ "CallCenter" ], "summary": "List all existing audio files", "parameters": [ { "name": "FolderName", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioFileQueryResult" } } } } } }, "delete": { "tags": [ "CallCenter" ], "summary": "Delete audio file", "parameters": [ { "name": "folderName", "in": "query", "schema": { "type": "string" } }, { "name": "fileName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AudioFile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "CallCenter" ], "summary": "Creates audio files", "parameters": [ { "name": "folderName", "in": "query", "schema": { "type": "string" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "resource": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "resource": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AudioFile" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/department": { "put": { "tags": [ "CallCenter" ], "summary": "Assign or change the brand (department) of an audio file", "parameters": [ { "name": "folderName", "in": "query", "schema": { "type": "string" } }, { "name": "fileName", "in": "query", "schema": { "type": "string" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/folder": { "post": { "tags": [ "CallCenter" ], "parameters": [ { "name": "folderName", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/folder/{folderName}": { "delete": { "tags": [ "CallCenter" ], "summary": "Delete audio file folder", "parameters": [ { "name": "folderName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/token": { "post": { "tags": [ "CallCenter" ], "summary": "Create token to listen to the audio file", "parameters": [ { "name": "fileName", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/audiofiles/play": { "get": { "tags": [ "CallCenter" ], "parameters": [ { "name": "folderName", "in": "query", "schema": { "type": "string" } }, { "name": "fileName", "in": "query", "schema": { "type": "string" } }, { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/settings": { "get": { "tags": [ "CallCenter" ], "summary": "Get details of a voip setting", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallCenter" ], "summary": "Update voip settings", "requestBody": { "description": "Voip setting data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoipSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/callcenter/calllogs/{id}/automationRunLogs": { "get": { "tags": [ "CallCenter" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/callcenter/sipservers": { "get": { "tags": [ "CallCenter" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SipServerQueryResult" } } } } } } }, "/v1/calltags/{id}": { "get": { "tags": [ "CallTag" ], "summary": "Get details of a call tag", "parameters": [ { "name": "id", "in": "path", "description": "Call tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CallTag" ], "summary": "Update tag", "parameters": [ { "name": "id", "in": "path", "description": "Call tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Call tag data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CallTag" ], "summary": "Delete call tag", "parameters": [ { "name": "id", "in": "path", "description": "call tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/calltags": { "get": { "tags": [ "CallTag" ], "summary": "List all existing call tags", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "SystemTag", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelQueryResult" } } } } } }, "post": { "tags": [ "CallTag" ], "summary": "Create call tag", "requestBody": { "description": "call tag data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CallTag" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CallTag" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CallTag" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CallTag" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/categories/{id}": { "get": { "tags": [ "Category" ], "summary": "Get details of a category", "parameters": [ { "name": "id", "in": "path", "description": "Category identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Category" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Category" ], "summary": "Delete category", "parameters": [ { "name": "id", "in": "path", "description": "Category identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/categories": { "get": { "tags": [ "Category" ], "summary": "List all existing categories", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryQueryResult" } } } } } }, "post": { "tags": [ "Category" ], "summary": "Create category", "requestBody": { "description": "Category data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Category" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Category" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Category" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Category" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/widget": { "get": { "tags": [ "Chat" ], "summary": "Get the current chat widget information (status, settings, etc.)", "parameters": [ { "name": "apiKey", "in": "query", "description": "Chat widget API key", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Url", "schema": { "type": "string" } }, { "name": "iosKey", "in": "query", "description": "Chat widget iOS key", "schema": { "type": "string" } }, { "name": "androidKey", "in": "query", "description": "Chat widget Android key", "schema": { "type": "string" } }, { "name": "visitorId", "in": "query", "description": "Contact Visitor ID", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Contact email", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Contact phone", "schema": { "type": "string" } }, { "name": "userHash", "in": "query", "description": "User hash (SHA256 HMAC, required if identity verification is forced)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/widget/histories": { "get": { "tags": [ "Chat" ], "summary": "Lists all chat histories", "parameters": [ { "name": "ApiKey", "in": "query", "schema": { "type": "string" } }, { "name": "VisitorId", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "schema": { "type": "string" } }, { "name": "UserHash", "in": "query", "schema": { "type": "string" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatHistoryResponseQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/newUserHash": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "apiKey", "in": "query", "schema": { "type": "string" } }, { "name": "visitorId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatModeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/widget/sendOtp": { "post": { "tags": [ "Chat" ], "summary": "Creates and sends an OTP to the visitor.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatHistoryResponseQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/widget/verifyOtp": { "post": { "tags": [ "Chat" ], "summary": "Verifies the OTP and returns a secure token for chat authentication.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatValidationModel" } } } }, "responses": { "200": { "description": "OK", "headers": { "X-RateLimit-Limit": { "description": "The maximum number of requests available in the current time frame.", "schema": { "type": "integer", "description": "The maximum number of requests available in the current time frame." }, "example": 100 }, "X-RateLimit-Remaining": { "description": "The number of remaining requests in the current time frame.", "schema": { "type": "integer", "description": "The number of remaining requests in the current time frame." }, "example": 80 }, "X-RateLimit-Reset": { "description": "The remaining seconds before the rate limit resets.", "schema": { "type": "integer", "description": "The remaining seconds before the rate limit resets." }, "example": 3600 } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OkResult" } } } }, "400": { "description": "Bad Request", "headers": { "X-RateLimit-Limit": { "description": "The maximum number of requests available in the current time frame.", "schema": { "type": "integer", "description": "The maximum number of requests available in the current time frame." }, "example": 100 }, "X-RateLimit-Remaining": { "description": "The number of remaining requests in the current time frame.", "schema": { "type": "integer", "description": "The number of remaining requests in the current time frame." }, "example": 80 }, "X-RateLimit-Reset": { "description": "The remaining seconds before the rate limit resets.", "schema": { "type": "integer", "description": "The remaining seconds before the rate limit resets." }, "example": 3600 } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/rooms": { "get": { "tags": [ "Chat" ], "summary": "List all chat rooms", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ChatId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "ChatTags", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "AssignedTo", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Channel", "in": "query", "schema": { "type": "string" } }, { "name": "ClosedActorType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ClosedBy", "in": "query", "schema": { "type": "string" } }, { "name": "FromClosingTime", "in": "query", "schema": { "type": "string" } }, { "name": "ToClosingTime", "in": "query", "schema": { "type": "string" } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CompanyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IsResolved", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Referrer", "in": "query", "schema": { "type": "string" } }, { "name": "IpAddress", "in": "query", "schema": { "type": "string" } }, { "name": "UtmSource", "in": "query", "schema": { "type": "string" } }, { "name": "UtmMedium", "in": "query", "schema": { "type": "string" } }, { "name": "UtmCampaign", "in": "query", "schema": { "type": "string" } }, { "name": "UtmContent", "in": "query", "schema": { "type": "string" } }, { "name": "UtmTerm", "in": "query", "schema": { "type": "string" } }, { "name": "FromLogTime", "in": "query", "schema": { "type": "string" } }, { "name": "ToLogTime", "in": "query", "schema": { "type": "string" } }, { "name": "FromNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "ToNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "SlaId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeTranscript", "in": "query", "schema": { "type": "boolean" } }, { "name": "MinCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ContactPhone", "in": "query", "schema": { "type": "string" } }, { "name": "UnlinkedToTicket", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeFeedback", "in": "query", "schema": { "type": "boolean" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomQueryResult" } } } } } } }, "/v1/chat/rooms/{roomId}/intents": { "get": { "tags": [ "Chat" ], "summary": "Get the intents detected for a chat room (AI intent classification),\r\noldest first. Powers the header intent badges in the dashboard; live\r\nadditions are pushed separately via the `newChatIntent` SignalR event.", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatRoomIntent" } } } } } } } }, "/v1/chat/rooms/{roomId}/sentiment": { "get": { "tags": [ "Chat" ], "summary": "Get the current sentiment detected for a chat room (AI sentiment classification).\r\nPowers the header sentiment badge in the dashboard; live updates are pushed\r\nseparately via the `newChatSentiment` SignalR event. Returns `null`\r\nwhen no sentiment has been detected for the room yet.", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomSentiment" } } } } } } }, "/v1/chat/rooms/{roomId}/customer-context": { "get": { "tags": [ "Chat" ], "summary": "Get the current customer context generated for a chat room (AI customer-context).\r\nPowers the dashboard's customer-context panel (initial load); live updates are pushed\r\nseparately via the `newCustomerContext` SignalR event. Returns `null`\r\nwhen no customer context has been generated for the room yet.", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRoomCustomerContext" } } } } } } }, "/v1/chat/rooms/{roomId}/suggestions": { "get": { "tags": [ "Chat" ], "summary": "Get the streaming suggestion snapshot (`{inFlight, last}`) for a chat room,\r\nproxied from copilot-service. Powers the initial load of the composer suggestion\r\ncard (mid-stream join + post-refresh render); live updates are pushed separately\r\nvia the `copilotStreamEvent` SignalR event. FAIL-OPEN: copilot-service being\r\nunconfigured, slow or down yields an empty snapshot (200 with both fields null),\r\nnever an error — the dashboard degrades to \"no suggestion yet\".", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomStreamSnapshotDto" } } } } } } }, "/v1/chat/rooms/{roomId}/suggestions/regenerate": { "post": { "tags": [ "Chat" ], "summary": "Queue an on-demand regeneration of the room's AI suggestion. Throttled by a\r\nper-room 30s Redis SETNX cooldown so agents (across pods) cannot flood the\r\ncopilot side. Progress reaches the dashboard through the normal\r\n`copilotStreamEvent` pushes. Returns the raw response object — NOT wrapped\r\nin `ApiResponse` — to mirror the ticket summary refresh endpoint:\r\n`{queued:true}` or `{queued:false, cooldownSeconds:N}`.", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/chat/rooms/{roomId}/suggestions/{suggestionId}/feedback": { "post": { "tags": [ "Chat" ], "summary": "Queue the current agent's approval (👍) or disapproval (👎) of one AI suggestion.\r\n`rating` is `up` | `down` | `none` (none withdraws). One vote per\r\nagent per suggestion — re-voting overwrites. Returns the raw object, NOT wrapped in\r\n`ApiResponse`, mirroring the sibling suggestion endpoints.", "description": "ASYNCHRONOUS: the vote is produced to `chat.copilot-feedback` and applied by\r\ncopilot-service, so `202` means \"accepted for delivery\", not \"stored\". The\r\nsuggestion-ownership check runs in the consumer and therefore cannot answer here —\r\nthat case becomes a DLQ record plus a counter, not a `404`. The trade is\r\ndeliberate: a queued vote survives an AI-side outage, which a synchronous write would\r\nnot. `503` is reserved for the broker refusing the produce, the only failure\r\ndetectable here.", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "suggestionId", "in": "path", "description": "Suggestion row id, taken from the suggestion payload.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The vote.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/chat/rooms/{roomId}/tags": { "post": { "tags": [ "Chat" ], "summary": "Add tags to a chat room", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "tagIds", "in": "query", "description": "Comma-separated Infoset.Types.Models.ChatTag IDs", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Chat" ], "summary": "Remove tags from a chat room", "parameters": [ { "name": "roomId", "in": "path", "description": "Room ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "tagIds", "in": "query", "description": "Comma-separated Infoset.Types.Models.ChatTag IDs", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/rooms/{roomId}": { "delete": { "tags": [ "Chat" ], "summary": "Delete chat room", "parameters": [ { "name": "roomId", "in": "path", "description": "Chat room identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/rooms/{roomId}/open": { "put": { "tags": [ "Chat" ], "summary": "Open an archived chat room", "parameters": [ { "name": "roomId", "in": "path", "description": "Chat room identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/rooms/{roomId}/close": { "put": { "tags": [ "Chat" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "markAsSolved", "in": "query", "schema": { "type": "boolean" } }, { "name": "apiKey", "in": "query", "schema": { "type": "string" } }, { "name": "visitorId", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } }, { "name": "userHash", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/messages": { "get": { "tags": [ "Chat" ], "summary": "List all chat messages", "parameters": [ { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "RoomId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ChatId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromUser", "in": "query", "schema": { "type": "string" } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IsNote", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "FromLogTime", "in": "query", "schema": { "type": "string" } }, { "name": "ToLogTime", "in": "query", "schema": { "type": "string" } }, { "name": "TargetLang", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageItemQueryResult" } } } } } }, "post": { "tags": [ "Chat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/NewMessageModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewMessageModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewMessageModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageItemQueryResult" } } } } } } }, "/v1/chat/messages/translate": { "post": { "tags": [ "Chat" ], "summary": "Translates visitor's messages in the room to agent's target lang", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatTranslateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatTranslateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatTranslateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatTranslateModel" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/messages/{id}": { "put": { "tags": [ "Chat" ], "summary": "Edit a chat message", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateChatMessageModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateChatMessageModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateChatMessageModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateChatMessageModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageItemQueryResult" } } } } } }, "delete": { "tags": [ "Chat" ], "summary": "Delete a chat message", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageItemQueryResult" } } } } } } }, "/v1/chat/logs": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "roomId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatStatusLogQueryResult" } } } } } } }, "/v1/chat/transfer": { "post": { "tags": [ "Chat" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatTransferModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatTransferModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatTransferModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatTransferModel" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/transcript": { "post": { "tags": [ "Chat" ], "summary": "Returns the chat transcript for a given room id", "parameters": [ { "name": "roomId", "in": "query", "description": "Chat room ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chat/{id}/automationRunLogs": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/chat/{id}/routingRunLogs": { "get": { "tags": [ "Chat" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingRunLogQueryResult" } } } } } } }, "/v1/chatbots/{id}": { "get": { "tags": [ "Chatbot" ], "summary": "Get details of a chatbot", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Chatbot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Chatbot" ], "summary": "Delete chatbot", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots": { "get": { "tags": [ "Chatbot" ], "summary": "List all existing chatbots", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "FirstMessage", "in": "query", "schema": { "type": "string" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedSubId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Status", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChatbotStatus" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotQueryResult" } } } } } }, "post": { "tags": [ "Chatbot" ], "summary": "Create chatbot", "requestBody": { "description": "Chatbot data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/configuration": { "put": { "tags": [ "Chatbot" ], "summary": "Builder aggregate save: chatbot configuration, channel links and optional custom hours.\r\nThe save never touches another bot: a channel already served by a published bot is rejected\r\nat publish time (channel_conflict blocker), not silently taken over.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatbotConfigurationRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/publish": { "post": { "tags": [ "Chatbot" ], "summary": "Publish the chatbot: snapshots the current config as a new immutable version", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/versions/{versionId}/rollback": { "post": { "tags": [ "Chatbot" ], "summary": "Roll the chatbot back to a previously published version", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "versionId", "in": "path", "description": "Target chatbot version identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/archive": { "post": { "tags": [ "Chatbot" ], "summary": "Archive the chatbot: it stops being offered to new visitors immediately", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/unarchive": { "post": { "tags": [ "Chatbot" ], "summary": "Unarchive the chatbot back to draft; going live again requires publish", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/unpublish": { "post": { "tags": [ "Chatbot" ], "summary": "Take the chatbot off the air: it goes back to draft and widgets stop offering it. Unlike\r\narchiving, the bot stays in the working list; the published version history is kept.", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/publish-check": { "get": { "tags": [ "Chatbot" ], "summary": "Check whether the chatbot meets the publish preconditions; returns per-condition blockers", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotPublishCheckModel" } } } } } } }, "/v1/chatbots/preview": { "post": { "tags": [ "Chatbot" ], "summary": "Preview a (possibly unsaved) chatbot configuration without persisting anything", "requestBody": { "description": "Chatbot configuration to preview; Id may be 0 for a new draft.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Chatbot" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Chatbot" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotPreviewModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/{id}/working-hours": { "get": { "tags": [ "Chatbot" ], "summary": "List the chatbot's published version history", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } } } } } }, "put": { "tags": [ "Chatbot" ], "summary": "Replace the chatbot's custom working hours. An empty list clears them.", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Full list of working hours; empty means \"no custom hours\".", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } } } } } } }, "/v1/chatbots/{id}/versions": { "get": { "tags": [ "Chatbot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotVersion" } } } } } } } }, "/v1/chatbots/objects/{id}": { "get": { "tags": [ "Chatbot" ], "summary": "Get details of a chatbot object", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot object identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Chatbot" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Chatbot" ], "summary": "Delete chatbot object", "parameters": [ { "name": "id", "in": "path", "description": "Chatbot object identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/objects": { "get": { "tags": [ "Chatbot" ], "summary": "List all existing chatbot objects", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Language", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObjectQueryResult" } } } } } }, "post": { "tags": [ "Chatbot" ], "summary": "Create chatbot object", "requestBody": { "description": "Chatbot object data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotObject" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/connections": { "get": { "tags": [ "ChatbotConnection" ], "summary": "List connections available to the caller (secrets masked).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotConnectionResponse" } } } } } } }, "post": { "tags": [ "ChatbotConnection" ], "summary": "Create a connection. The secret is stored encrypted and never returned.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/connections/{id}": { "get": { "tags": [ "ChatbotConnection" ], "summary": "Get a single connection (secret masked).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ChatbotConnection" ], "summary": "Update a connection. An empty secret keeps the stored one.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "ChatbotConnection" ], "summary": "Delete a connection.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatbots/connections/{id}/test": { "post": { "tags": [ "ChatbotConnection" ], "summary": "IDT-1994: try the connection against a real URL before publishing. A single SSRF-guarded\r\nGET with the connection's auth headers; the response body is never returned. A failed test\r\nis still HTTP 200 — the outcome is data, not an API error.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionTestRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionTestRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionTestRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionTestRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatbotConnectionTestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/chat/rooms/{roomId}": { "get": { "tags": [ "ChatRoomMetadata" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "description": "Optional brand scope. Bound as nullable so \"not supplied\" is distinguishable from \"supplied as\r\n0\": the copilot and sibling AI services omit it entirely and must keep their account-wide read,\r\nwhile a brand-scoped caller that computes a 0 has a bug and should be told so rather than\r\nsilently widened. Supplied and positive scopes the read to that brand and 404s on a mismatch;\r\nsupplied and non-positive is a 400.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RoomMetadataDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoomMetadataDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RoomMetadataDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/chat/rooms/{roomId}/thread": { "get": { "tags": [ "ChatRoomThread" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "schema": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ConversationThreadDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConversationThreadDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConversationThreadDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/chattags/{id}": { "get": { "tags": [ "ChatTag" ], "summary": "Get details of a chat tag", "parameters": [ { "name": "id", "in": "path", "description": "Chat tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ChatTag" ], "summary": "Update tag", "parameters": [ { "name": "id", "in": "path", "description": "Chat tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Chat tag data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "ChatTag" ], "summary": "Delete chat tag", "parameters": [ { "name": "id", "in": "path", "description": "chat tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chattags": { "get": { "tags": [ "ChatTag" ], "summary": "List all existing chat tags", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "SystemTag", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponseModelQueryResult" } } } } } }, "post": { "tags": [ "ChatTag" ], "summary": "Create chat tag", "requestBody": { "description": "Chat tag data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatTag" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chattags/messages": { "put": { "tags": [ "ChatTag" ], "summary": "Update chat tag message config", "requestBody": { "description": "Chat tag message config data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatTagMessageConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatTagMessageConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatTagMessageConfig" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatTagMessageConfig" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chattags/messages/{tagId}": { "get": { "tags": [ "ChatTag" ], "summary": "Get details of a chat tag message config", "parameters": [ { "name": "tagId", "in": "path", "description": "Chat tag identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatTag" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatwidgets/{id}": { "get": { "tags": [ "ChatWidget" ], "summary": "Get details of a chat widget.", "parameters": [ { "name": "id", "in": "path", "description": "Chat widget identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ChatWidget" ], "summary": "Update chat widget", "parameters": [ { "name": "id", "in": "path", "description": "Chat widget identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Chat widget data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "ChatWidget" ], "summary": "Delete Chat widget", "parameters": [ { "name": "id", "in": "path", "description": "Chat widget identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/chatwidgets": { "get": { "tags": [ "ChatWidget" ], "summary": "List all existing chat widgets.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Domain", "in": "query", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetResponseModelQueryResult" } } } } } }, "post": { "tags": [ "ChatWidget" ], "summary": "Saves a chat widget.", "requestBody": { "description": "Chat widget data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatWidgetModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}": { "get": { "tags": [ "Company" ], "summary": "Get details of a single company", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Company" ], "summary": "Update company", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Company data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Company" ], "summary": "Delete company", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies": { "get": { "tags": [ "Company" ], "summary": "List all existing companies", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "description": "Phone number with country code, without leading + (plus) sign, minimum 4 digits or empty.\r\nItems having a phone number that starts with the given value will be returned.", "schema": { "type": "string", "example": "12124567890" }, "example": "12124567890" }, { "name": "Address", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Town", "in": "query", "schema": { "type": "string" } }, { "name": "Web", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "FromCreatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToCreatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "CustomFields", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataFieldFilter" }, "nullable": true } } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Company" ], "summary": "Create company", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Company" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Company" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/search": { "get": { "tags": [ "Company" ], "summary": "Performs a text search on companies and returns the matching results", "parameters": [ { "name": "Query", "in": "query", "required": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "SearchInActivities", "in": "query", "description": "Executes the search in activities (notes, emails, calls, meetings, etc.)", "schema": { "type": "boolean" } }, { "name": "SearchType", "in": "query", "description": "Search type: Smart (default), Exact, Fuzzy

Enum values:

", "schema": { "$ref": "#/components/schemas/SearchType" } }, { "name": "Fuzziness", "in": "query", "description": "Fuzzy tolerance: None (default), Auto, Low (1), High (2)

Enum values:

", "schema": { "$ref": "#/components/schemas/FuzzinessTolerance" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponseModelQueryResult" } } } } } } }, "/v1/companies/insertbulk": { "post": { "tags": [ "Company" ], "summary": "Maximum 500 records can be bulk inserted at a time", "parameters": [ { "name": "returnFullData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { } } }, "application/json": { "schema": { "type": "array", "items": { } } }, "text/json": { "schema": { "type": "array", "items": { } } }, "application/*+json": { "schema": { "type": "array", "items": { } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyInsertBulkResponseWithData" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/files": { "get": { "tags": [ "Company" ], "summary": "Returns the files of a company", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Company" ], "summary": "Adds files to the company", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "resource": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File data" } } }, "encoding": { "resource": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileResponseModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/files/{fileId}": { "delete": { "tags": [ "Company" ], "summary": "Delete company file", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fileId", "in": "path", "description": "File identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/notes": { "get": { "tags": [ "Company" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Company" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{contactId}/notes/{noteId}": { "get": { "tags": [ "Company" ], "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Company" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/notes/{noteId}": { "delete": { "tags": [ "Company" ], "summary": "Delete company note", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "noteId", "in": "path", "description": "File identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/events": { "get": { "tags": [ "Company" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/activities": { "get": { "tags": [ "Company" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerActivityQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/merge": { "post": { "tags": [ "Company" ], "summary": "Merge contacts", "requestBody": { "description": "resource that includes ids and newcontact values", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompanyMergeRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMergeRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyMergeRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyMergeRequestModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/companies/{id}/automationRunLogs": { "get": { "tags": [ "Company" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/contacts/{id}": { "get": { "tags": [ "Contact" ], "summary": "Get details of a single contact", "parameters": [ { "name": "id", "in": "path", "description": "Contact identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Contact" ], "summary": "Update contact", "parameters": [ { "name": "id", "in": "path", "description": "Contact identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Contact data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Contact" ], "summary": "Delete contact", "parameters": [ { "name": "id", "in": "path", "description": "Contact identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts": { "get": { "tags": [ "Contact" ], "summary": "List all existing contacts", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CompanyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FullName", "in": "query", "schema": { "type": "string" } }, { "name": "FirstName", "in": "query", "schema": { "type": "string" } }, { "name": "LastName", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "Phone", "in": "query", "description": "Phone number with country code, without leading + (plus) sign, minimum 4 digits or empty.\r\nItems having a phone number that starts with the given value will be returned.", "schema": { "type": "string", "example": "12124567890" }, "example": "12124567890" }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "Address", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Town", "in": "query", "schema": { "type": "string" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "Job", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "type": "string", "description": "

Enum values:

" } }, { "name": "Blocked", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromCreatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToCreatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "CustomFields", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataFieldFilter" }, "nullable": true } } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Contact" ], "summary": "Create contact", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Contact" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Contact" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/search": { "get": { "tags": [ "Contact" ], "summary": "Performs a text search on contacts and returns the matching results", "parameters": [ { "name": "Query", "in": "query", "required": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "SearchInActivities", "in": "query", "description": "Executes the search in activities (notes, emails, calls, meetings, etc.)", "schema": { "type": "boolean" } }, { "name": "SearchType", "in": "query", "description": "Search type: Smart (default), Exact, Fuzzy

Enum values:

", "schema": { "$ref": "#/components/schemas/SearchType" } }, { "name": "Fuzziness", "in": "query", "description": "Fuzzy tolerance: None (default), Auto, Low (1), High (2)

Enum values:

", "schema": { "$ref": "#/components/schemas/FuzzinessTolerance" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponseModelQueryResult" } } } } } } }, "/v1/contacts/copygroup": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/movegroup": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/removegroup": { "post": { "tags": [ "Contact" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CopyGroupRequestModel" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/insertbulk": { "post": { "tags": [ "Contact" ], "summary": "Maximum 500 records can be bulk inserted at a time", "parameters": [ { "name": "returnFullData", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "maxItems": 500, "type": "array", "items": { } } }, "application/json": { "schema": { "maxItems": 500, "type": "array", "items": { } } }, "text/json": { "schema": { "maxItems": 500, "type": "array", "items": { } } }, "application/*+json": { "schema": { "maxItems": 500, "type": "array", "items": { } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactInsertBulkResponseWithData" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/files": { "get": { "tags": [ "Contact" ], "summary": "Returns the files of a contact", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Contact" ], "summary": "Adds files to the contact", "parameters": [ { "name": "id", "in": "path", "description": "Contact identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "resource": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File data" } } }, "encoding": { "resource": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileResponseModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/files/{fileId}": { "delete": { "tags": [ "Contact" ], "summary": "Delete contact file", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fileId", "in": "path", "description": "File identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/notes": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkedNoteCreateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{contactId}/notes/{noteId}": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "noteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Contact" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkedNote" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Contact" ], "summary": "Delete contact note", "parameters": [ { "name": "contactId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "noteId", "in": "path", "description": "File identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/events": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/activities": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerActivityQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/merge": { "post": { "tags": [ "Contact" ], "summary": "Merge contacts", "requestBody": { "description": "resource that includes ids and newcontact values", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContactMergeRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactMergeRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactMergeRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactMergeRequestModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tsoft/contacts": { "post": { "tags": [ "Contact" ], "summary": "Create contact for T-soft webhook", "parameters": [ { "name": "apiKey", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tsoft customer data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contacts/{id}/automationRunLogs": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/contacts/visitorData": { "get": { "tags": [ "Contact" ], "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatVisitorDataItem" } } } } } } }, "/v1/contactgroups/{id}": { "get": { "tags": [ "ContactGroup" ], "summary": "Get details of a contact group", "parameters": [ { "name": "id", "in": "path", "description": "Contact group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ContactGroup" ], "summary": "Update contact group", "parameters": [ { "name": "id", "in": "path", "description": "Contact group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Contact group data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "ContactGroup" ], "summary": "Delete contact group", "parameters": [ { "name": "id", "in": "path", "description": "Contact group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/contactgroups": { "get": { "tags": [ "ContactGroup" ], "summary": "List all existing contact groups", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroupResponseModelQueryResult" } } } } } }, "post": { "tags": [ "ContactGroup" ], "summary": "Create contact group", "requestBody": { "description": "Contact group data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/contacts/{contactId}": { "get": { "tags": [ "ContactInfo" ], "parameters": [ { "name": "contactId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ContactInfoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactInfoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactInfoDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/copilot/config": { "get": { "tags": [ "CopilotConfig" ], "summary": "Returns the Copilot configuration for the given account. Returns platform\r\ndefaults (enabled=false, …) for accounts with no row. accountId\r\nis required; the endpoint never falls back to the calling principal because the\r\ncaller is a service identity with no tenant scope of its own.", "parameters": [ { "name": "accountId", "in": "query", "description": "Tenant id (required, > 0).", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "description": "Optional brand scope; 0 (default) reads the account-level\r\n row. A department read with no row falls back to the account-level row as a whole,\r\n so existing callers that omit the param get exactly the dept-0 row as before.", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CopilotConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CopilotConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CopilotConfigDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/copilot/tickets/{ticketId}/thread": { "get": { "tags": [ "CopilotConfig" ], "summary": "Returns the ticket's conversation thread ({subject, messages[]}, oldest-first) for\r\nthe AI summary-service. Same shared-secret auth as the config endpoint (class-level\r\nattribute; the absolute route below only overrides the class route TEMPLATE, not the\r\nauth filter). Hard caps enforced by Infoset.Service.Hubs.Ticket.Service.ITicketThreadService: private notes\r\nexcluded, last 50 logs, 2000 chars per message, 24000 chars total. A ticket that does\r\nnot exist in the account — including a foreign-tenant ticket id, since every query is\r\nACCOUNT_ID-scoped — yields 404.", "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TicketThreadDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketThreadDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketThreadDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/admin/copilot/config": { "get": { "tags": [ "CopilotConfig" ], "summary": "Returns the Copilot configuration for the caller's account. Returns platform\r\ndefaults (enabled=false, …) if no row exists yet — no insert is performed.", "parameters": [ { "name": "departmentId", "in": "query", "description": "Optional brand scope; 0 (default) reads the account-level\r\n row. A department read with no row falls back to the account-level row as a whole.", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopilotConfigDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CopilotConfig" ], "summary": "Upserts the Copilot configuration for the caller's account. DataAnnotations\r\non Infoset.Types.Models.Admin.UpdateCopilotConfigDto are validated automatically by\r\n`[ApiController]`; invalid payloads return 400 with a structured error.", "description": "Emits an `aiSettings:updated` audit log entry on success when the stored config\r\nactually changed. No-op PUTs (incoming dto byte-equals the existing config)\r\ndo NOT produce an audit row. Mirrors the diff-then-log pattern used by\r\nInfoset.Api.Controllers.SettingController for `mailAccount:edit`.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateCopilotConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCopilotConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCopilotConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCopilotConfigDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/countries": { "get": { "tags": [ "Country" ], "summary": "List all existing countries", "parameters": [ { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "IsoCode", "in": "query", "schema": { "type": "string" } }, { "name": "Lang", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryResponseModelQueryResult" } } } } } } }, "/api/customer-context/detected": { "post": { "tags": [ "CustomerContext" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatCustomerContextRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatCustomerContextRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatCustomerContextRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatCustomerContextRequestDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/customer-context/rooms/{roomId}/exists": { "get": { "tags": [ "CustomerContext" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/customer-context/rooms/{roomId}/aggregate": { "get": { "tags": [ "CustomerContext" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "minimum": 1, "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomerContextAggregateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContextAggregateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContextAggregateDto" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/customfields/{id}": { "get": { "tags": [ "CustomField" ], "summary": "Get details of a custom field", "parameters": [ { "name": "id", "in": "path", "description": "CustomField identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CustomField" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CustomField" ], "summary": "Delete Custom Field", "parameters": [ { "name": "id", "in": "path", "description": "CustomField identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/customfields": { "get": { "tags": [ "CustomField" ], "summary": "List all existing Custom Fields", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "SystemField", "in": "query", "schema": { "type": "boolean" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldQueryResult" } } } } } }, "post": { "tags": [ "CustomField" ], "summary": "Create custom field", "requestBody": { "description": "Custom Field data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomField" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomField" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/customreports/dashboards": { "get": { "tags": [ "CustomReport" ], "parameters": [ { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomDashboardQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "CustomReport" ], "summary": "Create custom dashboard", "requestBody": { "description": "Custom dashboard data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/customreports/dashboards/{id}": { "get": { "tags": [ "CustomReport" ], "summary": "Get details of a custom dashboard", "parameters": [ { "name": "id", "in": "path", "description": "Custom dashboard identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomDashboard" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CustomReport" ], "summary": "Update custom dashboard", "parameters": [ { "name": "id", "in": "path", "description": "Custom dashboard identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Custom dashboard data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CustomReport" ], "summary": "Delete custom dashboard", "parameters": [ { "name": "id", "in": "path", "description": "Custom dashboard identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/customreports/reports": { "get": { "tags": [ "CustomReport" ], "parameters": [ { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomDashboardQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "CustomReport" ], "summary": "Create custom report", "requestBody": { "description": "Custom report data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomReport" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/customreports/reports/{id}": { "get": { "tags": [ "CustomReport" ], "summary": "Get details of a custom report", "parameters": [ { "name": "id", "in": "path", "description": "Custom report identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReport" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "CustomReport" ], "summary": "Update custom report", "parameters": [ { "name": "id", "in": "path", "description": "Custom report identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Custom report data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "CustomReport" ], "summary": "Delete custom report", "parameters": [ { "name": "id", "in": "path", "description": "Custom report identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dashboards": { "get": { "tags": [ "Dashboard" ], "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardQueryResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Dashboard" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dashboards/{id}": { "get": { "tags": [ "Dashboard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardQueryResult" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Dashboard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Dashboard" ], "summary": "Delete dashboard", "parameters": [ { "name": "id", "in": "path", "description": "Dashboard identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dashboards/widgets": { "post": { "tags": [ "Dashboard" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DashboardWidget" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidget" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DashboardWidget" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DashboardWidget" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dashboards/widgets/{id}": { "put": { "tags": [ "Dashboard" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Dashboard" ], "summary": "Delete dashboard widget", "parameters": [ { "name": "id", "in": "path", "description": "Dashboard widget identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardWidgetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/{id}": { "get": { "tags": [ "Deal" ], "summary": "Get details of a deal", "parameters": [ { "name": "id", "in": "path", "description": "Deal identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Deal" ], "summary": "Update deal", "parameters": [ { "name": "id", "in": "path", "description": "Deal identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Deal data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Deal" ], "summary": "Delete deal", "parameters": [ { "name": "id", "in": "path", "description": "Deal identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals": { "get": { "tags": [ "Deal" ], "summary": "List all existing deals", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "PipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "FromValue", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ToValue", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "Source", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealStatus" } } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ContactEmail", "in": "query", "schema": { "type": "string" } }, { "name": "CompanyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CreatedUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "OwnerUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "OwnerGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FollowerIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "Currency", "in": "query", "schema": { "type": "string" } }, { "name": "LostReason", "in": "query", "schema": { "type": "string" } }, { "name": "IsSpam", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "FromUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromExpectedCloseDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToExpectedCloseDate", "in": "query", "schema": { "type": "string" } }, { "name": "CustomFields", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataFieldFilter" }, "nullable": true } } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Deal" ], "summary": "Create deal", "requestBody": { "description": "Deal data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Deal" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/search": { "get": { "tags": [ "Deal" ], "summary": "Performs a text search on deals and returns the matching results", "parameters": [ { "name": "Query", "in": "query", "required": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "SearchInActivities", "in": "query", "description": "Executes the search in activities (notes, emails, calls, meetings, etc.)", "schema": { "type": "boolean" } }, { "name": "SearchType", "in": "query", "description": "Search type: Smart (default), Exact, Fuzzy

Enum values:

", "schema": { "$ref": "#/components/schemas/SearchType" } }, { "name": "Fuzziness", "in": "query", "description": "Fuzzy tolerance: None (default), Auto, Low (1), High (2)

Enum values:

", "schema": { "$ref": "#/components/schemas/FuzzinessTolerance" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealResponseModelQueryResult" } } } } } } }, "/v1/deals/logs": { "get": { "tags": [ "Deal" ], "summary": "Returns the deal logs of a deal", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DealId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealLogResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Deal" ], "summary": "Adds a log to the deal", "requestBody": { "description": "Deal log data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DealLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DealLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DealLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DealLog" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealLogResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/logs/{id}": { "put": { "tags": [ "Deal" ], "summary": "Update deal log", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/{id}/files": { "get": { "tags": [ "Deal" ], "summary": "Returns the files of a deal", "parameters": [ { "name": "id", "in": "path", "description": "Deal identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Deal" ], "summary": "Adds files to the deal", "parameters": [ { "name": "id", "in": "path", "description": "Deal identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "resource": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File data" } } }, "encoding": { "resource": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileResponseModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/files/{id}": { "delete": { "tags": [ "Deal" ], "summary": "Delete deal file", "parameters": [ { "name": "id", "in": "path", "description": "Deal file identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/changeorder": { "put": { "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "oldStageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "newStageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "oldOrderNo", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "newOrderNo", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/convertticket": { "put": { "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "pipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "stageId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/insertbulk": { "post": { "tags": [ "Deal" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponseModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponseModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponseModel" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/merge": { "post": { "tags": [ "Deal" ], "summary": "Merge deals", "requestBody": { "description": "resource that includes ids and newdeal values", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DealMergeRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DealMergeRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DealMergeRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DealMergeRequestModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/deals/{id}/automationRunLogs": { "get": { "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/deals/{id}/routingRunLogs": { "get": { "tags": [ "Deal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingRunLogQueryResult" } } } } } } }, "/v1/dialers/{id}": { "get": { "tags": [ "Dialer" ], "summary": "Get details of a Dialer", "parameters": [ { "name": "id", "in": "path", "description": "Dialer identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Dialer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Dialer" ], "summary": "Delete dialer", "parameters": [ { "name": "id", "in": "path", "description": "Dialer identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dialers": { "get": { "tags": [ "Dialer" ], "summary": "List all existing Dialers", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SipServerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerModelQueryResult" } } } } } }, "post": { "tags": [ "Dialer" ], "summary": "Create dialer (auto, predictive...)", "requestBody": { "description": "Dialer data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DialerModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DialerModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dialers/session": { "get": { "tags": [ "Dialer" ], "summary": "List all existing Dialer sessions", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DialerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerSessionModelQueryResult" } } } } } } }, "/v1/dialers/session/log": { "get": { "tags": [ "Dialer" ], "summary": "List all existing Dialer session logs", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DialerId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DialerSessionId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "PhoneNumber", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "LastCallState", "in": "query", "description": "Son Arama Durumu: =0 Tanımsız, =1 Meşgul, =2 Cevap Yok, =3 Numara Hatalı, =4 Arama Başarı ile tamamlandı", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerSessionLogModelQueryResult" } } } } } } }, "/v1/dialers/dtmf": { "post": { "tags": [ "Dialer" ], "summary": "Create Dialer DTMF Key", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/dialers/dtmf/{id}": { "put": { "tags": [ "Dialer" ], "summary": "", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "get": { "tags": [ "Dialer" ], "summary": "Get details of a Dialer Dtmf", "parameters": [ { "name": "id", "in": "path", "description": "Dialer Dtmf identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Dialer" ], "summary": "Delete dialer dtmf", "parameters": [ { "name": "id", "in": "path", "description": "Dialer dtmf identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DialerDtmfLinkModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/attachments/zip": { "post": { "tags": [ "Email" ], "summary": "Download multiple email attachments as a single ZIP", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipAttachmentRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipAttachmentRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipAttachmentRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipAttachmentRequest" } } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/send": { "post": { "tags": [ "Email" ], "summary": "Adds a new email to the send mail queue.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int64" }, "DepartmentId": { "type": "integer", "format": "int64" }, "MailAccountId": { "type": "integer", "format": "int64" }, "FromAddress": { "type": "string" }, "FromName": { "type": "string" }, "ToAddress": { "type": "string" }, "CcAddress": { "type": "string" }, "BccAddress": { "type": "string" }, "Subject": { "type": "string" }, "Content": { "type": "string" }, "Priority": { "$ref": "#/components/schemas/EmailPriority" }, "LinkedType": { "$ref": "#/components/schemas/Table" }, "LinkedId": { "type": "integer", "format": "int64" }, "ReplyMessageId": { "type": "string", "description": "Set when this email is reply for a specific email (e.g. when it's a reply to NOT the latest email in a ticket)" }, "ReplyReferences": { "type": "string" }, "ReplyLogId": { "type": "integer", "format": "int64" }, "IsForward": { "type": "integer", "format": "int32" }, "OutboxAppend": { "type": "boolean", "description": "Whether to append this email in sender's outbox or not" }, "Attachments": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "Id": { "style": "form" }, "DepartmentId": { "style": "form" }, "MailAccountId": { "style": "form" }, "FromAddress": { "style": "form" }, "FromName": { "style": "form" }, "ToAddress": { "style": "form" }, "CcAddress": { "style": "form" }, "BccAddress": { "style": "form" }, "Subject": { "style": "form" }, "Content": { "style": "form" }, "Priority": { "style": "form" }, "LinkedType": { "style": "form" }, "LinkedId": { "style": "form" }, "ReplyMessageId": { "style": "form" }, "ReplyReferences": { "style": "form" }, "ReplyLogId": { "style": "form" }, "IsForward": { "style": "form" }, "OutboxAppend": { "style": "form" }, "Attachments": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/send2": { "post": { "tags": [ "Email" ], "summary": "Adds a new email to the send mail queue. This endpoint does not contain the attached files", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EmailQueueModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EmailQueueModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmailQueueModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EmailQueueModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/{id}": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/{id}/retry": { "put": { "tags": [ "Email" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/email/{emailId}/files": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "emailId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailFileQueryResult" } } } } } } }, "/v1/email/read": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/events/{id}": { "get": { "tags": [ "Event" ], "summary": "Get details of an event", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Event" ], "summary": "Delete event", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/events": { "get": { "tags": [ "Event" ], "summary": "List all existing events", "parameters": [ { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventQueryResult" } } } } } }, "post": { "tags": [ "Event" ], "summary": "Create event", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Event" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Event" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Event" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/forbiddenwords": { "get": { "tags": [ "ForbiddenWordConfig" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenWordConfig" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ForbiddenWordConfig" ], "summary": "Create or update a forbidden word config for a single department.\r\nFE birden fazla markaya uygulamak isterse her marka için ayrı PUT atar.", "requestBody": { "description": "Forbidden word config data (DepartmentId zorunlu).", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/forbiddenwords/{departmentId}": { "get": { "tags": [ "ForbiddenWordConfig" ], "parameters": [ { "name": "departmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForbiddenWordConfig" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/forbiddenwords/{id}": { "delete": { "tags": [ "ForbiddenWordConfig" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/chat/rooms/{roomId}/genai-owner": { "post": { "tags": [ "GenAiChatOwnership" ], "summary": "Claims the room. `200` with `owned: false` means somebody else holds it and the\r\ncaller must withdraw — that is not an error condition and is not reported as one.", "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiOwnershipResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/genai/config": { "get": { "tags": [ "GenAiConfig" ], "summary": "Returns the resolved configuration for one `(accountId, departmentId)` pair.\r\n \r\n404 when the brand has no row — deliberately not a 200 carrying `enabled: false`. The\r\ncaller treats 404 as \"disabled, cache the negative\", which is cheaper and unambiguous. A row\r\nthat was explicitly switched off does return 200 with `enabled: false`.", "parameters": [ { "name": "accountId", "in": "query", "description": "Tenant id. Required, > 0.", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "description": "Brand id. Required, > 0 — there is no account-level row and no\r\n brand fallback, so a 0 here has no meaning and is rejected rather than widened.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GenAiConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiConfigDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/admin/genai/config": { "get": { "tags": [ "GenAiConfig" ], "summary": "Returns the resolved configuration for one brand, or 404 when that brand has no row.\r\n \r\n404 means \"never switched on\" and is not an error condition; a brand that was explicitly\r\nswitched off returns 200 with `enabled: false`. Keeping those two distinguishable is\r\nwhy no defaults DTO is fabricated here.", "parameters": [ { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenAiConfigDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "GenAiConfig" ], "summary": "Creates or updates one brand's configuration. The row is created on the first save of any\r\nkind, including one that switches the feature off.", "description": "Validate-then-write throughout: brand access is checked here, and the service refuses an\r\nunhonourable trigger object or an enable with no knowledge base before anything is\r\npersisted. The server-managed identity pointer has no property on the request DTO; a save\r\nthat switches the feature ON establishes it (once per brand, reused forever after), and any\r\nother save preserves it.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateGenAiConfigDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateGenAiConfigDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateGenAiConfigDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateGenAiConfigDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/chat/rooms/{roomId}/genai-handoff": { "post": { "tags": [ "GenAiHandoff" ], "summary": "Releases the assistant's ownership and triggers routing.", "description": "Every field of the `200` body can be false and none of them is an error:\r\n`released: false` is \"a human got there first\", `dispatched: false` is \"this tenant has\r\nno live-chat routing queue\", `alreadyHandled: true` is \"you already sent this\". A caller must\r\nnot retry on any of them — only a 5xx is a failure on this route.\r\n\n\r\nThe one retryable outcome therefore IS a 5xx: `503` with\r\n`ResultCode.GenAiHandoffRoomUnreadable` means the release happened but the room could not be\r\nre-read, so routing was never triggered and the replay gate was deliberately withheld. Retry it —\r\nthe redelivery is the only thing that can finish the transfer.\r\n", "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GenAiHandoffResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiHandoffResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/chat/rooms/{roomId}/genai-resolve": { "post": { "tags": [ "GenAiResolve" ], "summary": "Closes the room as solved on the assistant's behalf.", "description": "Every field of the `200` body can be false and none of them is an error:\r\n`closed: false` with `alreadyClosed: false` is \"a human owns it now\",\r\n`alreadyClosed: true` is the idempotent no-op, `alreadyHandled: true` is \"you already\r\nsent this\". A caller must not retry on any of them — only a 5xx is a failure here, and the\r\n`503` is the one branch that MUST be retried.", "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenAiResolveRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiResolveRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiResolveRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenAiResolveRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GenAiResolveResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiResolveResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiResolveResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } } } } }, "/api/chat/rooms/{roomId}/typing": { "post": { "tags": [ "GenAiTyping" ], "parameters": [ { "name": "roomId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accountId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenAiTypingRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiTypingRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiTypingRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenAiTypingRequestDto" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GenAiTypingResponseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenAiTypingResponseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenAiTypingResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/helpcenter/articles/visibility-warnings": { "get": { "tags": [ "HelpCenter" ], "parameters": [ { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "desk", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticleQueryResult" } } } } } } }, "/v1/helpcenter/articles/{id}": { "get": { "tags": [ "HelpCenter" ], "summary": "Get details of a single article", "parameters": [ { "name": "id", "in": "path", "description": "Article identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "HelpCenter" ], "summary": "Update article", "parameters": [ { "name": "id", "in": "path", "description": "Article identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Article data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "HelpCenter" ], "summary": "Delete article", "parameters": [ { "name": "id", "in": "path", "description": "Article identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/articles": { "get": { "tags": [ "HelpCenter" ], "parameters": [ { "name": "desk", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "query", "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "isDraft", "in": "query", "schema": { "type": "boolean" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticleQueryResult" } } } } } }, "post": { "tags": [ "HelpCenter" ], "summary": "Create article", "requestBody": { "description": "Article data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskArticle" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/articles/insertorupdatebulk": { "post": { "tags": [ "HelpCenter" ], "summary": "Bulk importing articles, updating existing ones if they share the same ID.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticle" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticle" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticle" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticle" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/collections/{id}": { "get": { "tags": [ "HelpCenter" ], "summary": "Get details of a single collection", "parameters": [ { "name": "id", "in": "path", "description": "Article identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "HelpCenter" ], "summary": "Update collection", "parameters": [ { "name": "id", "in": "path", "description": "Collection identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Collection data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "HelpCenter" ], "summary": "Delete collection", "parameters": [ { "name": "id", "in": "path", "description": "Collection identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/collections": { "get": { "tags": [ "HelpCenter" ], "parameters": [ { "name": "desk", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollectionQueryResult" } } } } } }, "post": { "tags": [ "HelpCenter" ], "summary": "Create collection", "requestBody": { "description": "Collection data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HelpdeskCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/desks": { "get": { "tags": [ "HelpCenter" ], "summary": "Get details of a desk", "parameters": [ { "name": "desk", "in": "query", "schema": { "type": "string" } }, { "name": "settings", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Desk" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "HelpCenter" ], "summary": "Create desk", "requestBody": { "description": "Desk data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Desk" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Desk" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/helpcenter/desks/{id}": { "put": { "tags": [ "HelpCenter" ], "summary": "Update desk", "parameters": [ { "name": "id", "in": "path", "description": "desk identifier.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Desk data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Desk" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Desk" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Desk" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "HelpCenter" ], "summary": "Delete desk", "parameters": [ { "name": "id", "in": "path", "description": "desk identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/integration/capabilities": { "get": { "tags": [ "IntegrationCapabilities" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationCapabilityResponseModelQueryResult" } } } } } } }, "/v1/integration/whatsapp/{id}/configs/templates": { "get": { "tags": [ "IntegrationCapabilities" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "source", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/intent/detected": { "post": { "tags": [ "Intent" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatIntentRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatIntentRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatIntentRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatIntentRequestDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/ai/kb-sync-plan": { "get": { "tags": [ "KbSyncPlan" ], "summary": "Returns the cross-tenant reconciliation plan: every account that has any department\r\nrow or any copilot_config row, with its departments (active AND passive) and per-brand\r\nCopilot desk selections.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KbSyncPlanResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KbSyncPlanResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KbSyncPlanResponse" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/login/token": { "post": { "tags": [ "Login" ], "summary": "Returns a user token if the given email and password are correct.\r\n\r\nIf the user has multi-factor authentication enabled, this endpoints sends the OTP (one-time password) and returns `{ mfaEnabled: true, mfaMethod: _User's_MFA_Method_ }`.\r\nAnother request to must be made to /v1/login/mfa/token with the correct OTP.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TokenRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TokenRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TokenRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TokenRequestModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/login/mfa/token": { "post": { "tags": [ "Login" ], "summary": "Returns a user token if the given multi-factor authentication code is correct", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TokenRequestModelMfa" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TokenRequestModelMfa" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TokenRequestModelMfa" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TokenRequestModelMfa" } } } }, "responses": { "200": { "description": "OK", "headers": { "X-RateLimit-Limit": { "description": "The maximum number of requests available in the current time frame.", "schema": { "type": "integer", "description": "The maximum number of requests available in the current time frame." }, "example": 100 }, "X-RateLimit-Remaining": { "description": "The number of remaining requests in the current time frame.", "schema": { "type": "integer", "description": "The number of remaining requests in the current time frame." }, "example": 80 }, "X-RateLimit-Reset": { "description": "The remaining seconds before the rate limit resets.", "schema": { "type": "integer", "description": "The remaining seconds before the rate limit resets." }, "example": 3600 } } } } } }, "/v1/logout": { "post": { "tags": [ "Login" ], "responses": { "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResource" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/notifications/{id}": { "get": { "tags": [ "Notification" ], "summary": "Get details of a notification", "parameters": [ { "name": "id", "in": "path", "description": "Notification identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Notification" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Notification" ], "summary": "Delete notification", "parameters": [ { "name": "id", "in": "path", "description": "Notification identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/notifications": { "get": { "tags": [ "Notification" ], "summary": "List all existing notifications", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IsRead", "in": "query", "schema": { "type": "boolean" } }, { "name": "Type", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationQueryResult" } } } } } }, "post": { "tags": [ "Notification" ], "summary": "Create a custom notification.\r\nCustom notifications can only be created by using account's API key or by using an admin token.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomNotificationCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomNotificationCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomNotificationCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomNotificationCreateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/outbound/messages/{id}": { "get": { "tags": [ "OutboundMessage" ], "summary": "Get details of an outbound message.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "OutboundMessage" ], "summary": "Update outbound message", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Outbound message data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "OutboundMessage" ], "summary": "Delete outbound message", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/outbound/messages/{id}/logs": { "get": { "tags": [ "OutboundMessage" ], "summary": "Get results of an outbound message.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Action", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/OutboundMessageAction" } }, { "name": "ActionValue", "in": "query", "schema": { "type": "string" } }, { "name": "VisitorId", "in": "query", "schema": { "type": "string" } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromCreatedAt", "in": "query", "schema": { "type": "string" } }, { "name": "ToCreatedAt", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageLogQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/outbound/messages": { "get": { "tags": [ "OutboundMessage" ], "summary": "List all existing outbound messages.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/OutboundMessageType" } }, { "name": "SendType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/OutboundMessageSendType" } }, { "name": "Status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromCreatedAt", "in": "query", "schema": { "type": "string" } }, { "name": "ToCreatedAt", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessageResponseModelQueryResult" } } } } } }, "post": { "tags": [ "OutboundMessage" ], "summary": "Saves an outbound message.", "requestBody": { "description": "Outbound message data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutboundMessage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/outbound/messages/preview": { "post": { "tags": [ "OutboundMessage" ], "summary": "Get preview count for outbound message filters", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OutboundPreviewRequestBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OutboundPreviewRequestBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OutboundPreviewRequestBody" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OutboundPreviewRequestBody" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewCountResult" } } } } } } }, "/v1/permission-profiles": { "get": { "tags": [ "PermissionProfile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfileQueryResult" } } } } } }, "post": { "tags": [ "PermissionProfile" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/non-grantable": { "get": { "tags": [ "PermissionProfile" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonGrantableRightsDescriptor" } } } } } } }, "/v1/permission-profiles/users/{userId}": { "get": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } } } } }, "/v1/permission-profiles/{id}": { "get": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/{id}/clone": { "post": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CloneProfileRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CloneProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloneProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloneProfileRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/{id}/rights": { "put": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileRight" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileRight" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileRight" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileRight" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/{id}/voip-rights": { "get": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" } } } } } } }, "put": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/{id}/external-number-rights": { "get": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" } } } } } } }, "put": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfile" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/permission-profiles/{id}/users": { "get": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionProfileUserQueryResult" } } } } } }, "post": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddProfileUserRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddProfileUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddProfileUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddProfileUserRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/permission-profiles/{id}/users/{userId}": { "delete": { "tags": [ "PermissionProfile" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/pipelines/{id}": { "get": { "tags": [ "Pipeline" ], "summary": "Get details of a pipeline", "parameters": [ { "name": "id", "in": "path", "description": "Pipeline identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Pipeline" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Pipeline" ], "summary": "Delete pipeline", "parameters": [ { "name": "id", "in": "path", "description": "Pipeline identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/pipelines": { "get": { "tags": [ "Pipeline" ], "summary": "List all existing pipelines", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "GetAll", "in": "query", "schema": { "type": "boolean" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineQueryResult" } } } } } }, "post": { "tags": [ "Pipeline" ], "summary": "Create pipeline", "requestBody": { "description": "Pipeline data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Pipeline" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pipeline" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/plans": { "get": { "tags": [ "Plan" ], "parameters": [ { "name": "currency", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfosetPlan" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/plans/resource": { "get": { "tags": [ "Plan" ], "parameters": [ { "name": "planId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfosetPlanResource" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/plans/packet": { "get": { "tags": [ "Plan" ], "parameters": [ { "name": "billingUnit", "in": "query", "description": "2: month, 3:year, 4:unlimeted(free)

Enum values:

", "schema": { "$ref": "#/components/schemas/BillingUnit" } }, { "name": "currency", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfosetPlanPacket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/reactions/toggle": { "post": { "tags": [ "Reaction" ], "summary": "Creates a Reaction", "parameters": [ { "name": "DealLogId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "TicketLogId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserReactionCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserReactionCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserReactionCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserReactionCreateModel" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/report/chatbot/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportChatbotOverviewModelQueryResult" } } } } } } }, "/v1/report/deal/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDealOverviewModelQueryResult" } } } } } } }, "/v1/report/deal/totals/pipeline": { "get": { "tags": [ "Report" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportDealPipelineModelQueryResult" } } } } } } }, "/v1/report/deal/totals/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsModelQueryResult" } } } } } } }, "/v1/report/deal/totals/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsModelQueryResult" } } } } } } }, "/v1/report/deal/totals/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsUserModelQueryResult" } } } } } } }, "/v1/report/deal/totals/source": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsSourceModelQueryResult" } } } } } } }, "/v1/report/deal/totals/stage": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsStageModelQueryResult" } } } } } } }, "/v1/report/deal/totals/lostreason": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "Currency", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalDealsStageModelQueryResult" } } } } } } }, "/v1/report/ticket/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketOverviewModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/pipeline": { "get": { "tags": [ "Report" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketPipelineModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/category": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketCategoryPerformanceModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketUserPerformanceModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/userlogs": { "get": { "tags": [ "Report" ], "summary": "User performance report by ticket logs", "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketUserPerformanceModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/source": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsSourceModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/stage": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsStageModelQueryResult" } } } } } } }, "/v1/report/ticket/totals/priority": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsPriorityModelQueryResult" } } } } } } }, "/v1/report/ticket/replies": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsPriorityModelQueryResult" } } } } } } }, "/v1/report/ticket/reply/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalTicketsPriorityModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/priority": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityTypeFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/source": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSourceFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/category": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCategoryFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/stage": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketStageFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketUserFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketDailyFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/firstresponse/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketDailyFRTModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRDayModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRMonthModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/category": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRPriorityModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/priority": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRPriorityModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/source": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRSourceModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/stage": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRStageModelQueryResult" } } } } } } }, "/v1/report/ticket/fcr/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketFCRUserModelQueryResult" } } } } } } }, "/v1/report/ticket/timeentries": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "TicketSubject", "in": "query", "schema": { "type": "string" } }, { "name": "AgentName", "in": "query", "schema": { "type": "string" } }, { "name": "AgentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "TicketPriority", "in": "query", "schema": { "type": "string" } }, { "name": "TicketStatus", "in": "query", "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketTimeEntryModelQueryResult" } } } } } } }, "/v1/report/ticket/timeentries/timeinfo": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "TicketSubject", "in": "query", "schema": { "type": "string" } }, { "name": "AgentName", "in": "query", "schema": { "type": "string" } }, { "name": "AgentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "TicketPriority", "in": "query", "schema": { "type": "string" } }, { "name": "TicketStatus", "in": "query", "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTicketTimeEntryTimeInfoModel" } } } } } } }, "/v1/report/ticket/csat": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateModelQueryResult" } } } } } } }, "/v1/report/ticket/csat/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateOverviewModelQueryResult" } } } } } } }, "/v1/report/ticket/csat/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateByUserModelQueryResult" } } } } } } }, "/v1/report/ticket/csat/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateDailyModelQueryResult" } } } } } } }, "/v1/report/ticket/workinglogs": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "PipelineIds", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportWorkingLogModelQueryResult" } } } } } } }, "/v1/report/user/totals/availability": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateDailyModelQueryResult" } } } } } } }, "/v1/report/user/availability/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateDailyModelQueryResult" } } } } } } }, "/v1/report/user/totals/state": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUserTotalStateModelQueryResult" } } } } } } }, "/v1/report/user/totals/state/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUserTotalStateOverviewModelQueryResult" } } } } } } }, "/v1/report/user/totals/activity": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUserTotalActivityModelQueryResult" } } } } } } }, "/v1/report/user/activity/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUserActivityOverviewModelQueryResult" } } } } } } }, "/v1/report/user/group/availability": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUserGroupAvailabilityModelQueryResult" } } } } } } }, "/v1/report/chat/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportChatSummaryModelQueryResult" } } } } } } }, "/v1/report/chat/summary": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportChatSummaryModelQueryResult" } } } } } } }, "/v1/report/chat/totals/hour": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatModelQueryResult" } } } } } } }, "/v1/report/chat/totals/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatModelQueryResult" } } } } } } }, "/v1/report/chat/totals/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatModelQueryResult" } } } } } } }, "/v1/report/chat/totals/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatUserModelQueryResult" } } } } } } }, "/v1/report/chat/agentratings": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatUserModelQueryResult" } } } } } } }, "/v1/report/chat/totals/city": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatCityModelQueryResult" } } } } } } }, "/v1/report/chat/visitor": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportChatVisitorProfileModel" } } } } } } }, "/v1/report/outbound/conversion": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "types", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportOutboundMessageConversionModelQueryResult" } } } } } } }, "/v1/report/chat/abandoned": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportChatQueueAbandonModelQueryResult" } } } } } } }, "/v1/report/chat/csat": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateModelQueryResult" } } } } } } }, "/v1/report/chat/csat/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateOverviewModelQueryResult" } } } } } } }, "/v1/report/chat/csat/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateByUserModelQueryResult" } } } } } } }, "/v1/report/chat/csat/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateDailyModelQueryResult" } } } } } } }, "/v1/report/queue/agentratings": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Channel", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } }, { "name": "CountryCode", "in": "query", "schema": { "type": "string" } }, { "name": "City", "in": "query", "schema": { "type": "string" } }, { "name": "Url", "in": "query", "schema": { "type": "string" } }, { "name": "WidgetId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "AssignedGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalChatUserModelQueryResult" } } } } } } }, "/v1/report/queue/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCallLogOverviewModelQueryResult" } } } } } } }, "/v1/report/queue/availability": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportAvailabilityModelQueryResult" } } } } } } }, "/v1/report/queue/summary": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueCallSummaryModelQueryResult" } } } } } } }, "/v1/report/queue/totals/hour": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalCallsModelQueryResult" } } } } } } }, "/v1/report/queue/totals/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalCallsModelQueryResult" } } } } } } }, "/v1/report/queue/totals/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalCallsModelQueryResult" } } } } } } }, "/v1/report/queue/avgwait/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueAvgWaitTimeModelQueryResult" } } } } } } }, "/v1/report/queue/avgwait/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueAvgWaitTimeModelQueryResult" } } } } } } }, "/v1/report/queue/duration": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalDurationModelQueryResult" } } } } } } }, "/v1/report/queue/duration/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalDurationByDayModelQueryResult" } } } } } } }, "/v1/report/queue/duration/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueTotalDurationByDayModelQueryResult" } } } } } } }, "/v1/report/queue/sl": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueSLModelQueryResult" } } } } } } }, "/v1/report/queue/abandoned": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportQueueAbandonedModelQueryResult" } } } } } } }, "/v1/report/queue/csat": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateModelQueryResult" } } } } } } }, "/v1/report/queue/csat/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateOverviewModelQueryResult" } } } } } } }, "/v1/report/queue/csat/user": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateByUserModelQueryResult" } } } } } } }, "/v1/report/queue/csat/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCSATRateDailyModelQueryResult" } } } } } } }, "/v1/report/calllog/tags": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalCallLogTagsModelQueryResult" } } } } } } }, "/v1/report/cdr/list": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCallLogModelQueryResult" } } } } } } }, "/v1/report/cdr/overview": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCallLogOverviewModelQueryResult" } } } } } } }, "/v1/report/cdr/availability": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportAvailabilityModelQueryResult" } } } } } } }, "/v1/report/cdr/totals/hour": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalCallsModelQueryResult" } } } } } } }, "/v1/report/cdr/totals/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalCallsModelQueryResult" } } } } } } }, "/v1/report/cdr/totals/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportTotalCallsModelQueryResult" } } } } } } }, "/v1/report/agent/performance": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/performance/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/performance/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/queue/performance": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/queue/performance/day": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/queue/performance/month": { "get": { "tags": [ "Report" ], "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/agent/productivity": { "get": { "tags": [ "Report" ], "summary": "The total talk time of an operator / session time. If an operator with a total 5-hour session spends 1 hour talking\r\nto the customer, the efficiency is 20%", "parameters": [ { "name": "fromDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportCCAgentProductivityRateModelQueryResult" } } } } } } }, "/v1/report/slas/ticketdetails": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by users", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaTicketDetailModelQueryResult" } } } } } } }, "/v1/report/slas/chatdetails": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by users", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaChatDetailModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/byusers": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by users", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaAgentPerformanceModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/bystatus": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by status", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesStatusModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/bypriority": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by priority", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesStatusModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/bysource": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by source", "parameters": [ { "name": "fromDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "Format 'yyyy-MM-ddTHH:mm:ss.000Z'", "required": true, "schema": { "type": "string" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesStatusModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/byhour": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by hour", "parameters": [ { "name": "fromDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "linkedType", "in": "query", "description": "

Enum values:

", "required": true, "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesTimeModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/byday": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by day", "parameters": [ { "name": "fromDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "linkedType", "in": "query", "description": "

Enum values:

", "required": true, "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesTimeModelQueryResult" } } } } } } }, "/v1/report/slas/breaches/bymonth": { "get": { "tags": [ "Report" ], "summary": "SLA breaches by month", "parameters": [ { "name": "fromDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "linkedType", "in": "query", "description": "

Enum values:

", "required": true, "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "pipelineIds", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "

Enum values:

", "schema": { "$ref": "#/components/schemas/ChannelType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSlaBreachesTimeModelQueryResult" } } } } } } }, "/v1/reportvisibility": { "get": { "tags": [ "ReportVisibility" ], "summary": "Get list of report visibilities", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Category", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ReportCategory" } }, { "name": "Visibility", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/VisibilityType" } }, { "name": "VisibleTo", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVisibilityResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "ReportVisibility" ], "summary": "Create Report Visibility", "requestBody": { "description": "Filter data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/reportvisibility/{id}": { "get": { "tags": [ "ReportVisibility" ], "summary": "Get report visibility by id.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "ReportVisibility" ], "summary": "Update report visibility", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Visibility data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportVisibility" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/routing-queues": { "get": { "tags": [ "RoutingQueue" ], "parameters": [ { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "LinkedType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueueListItemQueryResult" } } } } } }, "post": { "tags": [ "RoutingQueue" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueueDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/routing-queues/{id}": { "get": { "tags": [ "RoutingQueue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueueDetail" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "RoutingQueue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RoutingQueue" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingQueueDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "RoutingQueue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/savedfilter": { "get": { "tags": [ "SavedFilter" ], "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Visibility", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/SavedFilterVisibility" } }, { "name": "VisibleTo", "in": "query", "schema": { "type": "string" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "IsFromSettings", "in": "query", "schema": { "type": "boolean", "readOnly": true } }, { "name": "IncludeCounts", "in": "query", "schema": { "type": "boolean", "readOnly": true } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilterResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "SavedFilter" ], "summary": "Create filter", "requestBody": { "description": "Filter data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/savedfilter/{id}": { "get": { "tags": [ "SavedFilter" ], "summary": "Get details of a saved filter", "parameters": [ { "name": "id", "in": "path", "description": "Saved filter identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilter" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "SavedFilter" ], "summary": "Update filter", "parameters": [ { "name": "id", "in": "path", "description": "Filter identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Filter data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilterResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "SavedFilter" ], "summary": "Delete filter", "parameters": [ { "name": "id", "in": "path", "description": "Filter identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedFilterResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/savedreplies/{id}": { "get": { "tags": [ "SavedReply" ], "summary": "Get details of a saved reply", "parameters": [ { "name": "id", "in": "path", "description": "Saved Reply identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "SavedReply" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "SavedReply" ], "summary": "Delete saved reply", "parameters": [ { "name": "id", "in": "path", "description": "Saved reply identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/savedreplies": { "get": { "tags": [ "SavedReply" ], "summary": "List all existing saved replies", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Msg", "in": "query", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedReplyQueryResult" } } } } } }, "post": { "tags": [ "SavedReply" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SavedReply" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SavedReply" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavedReply" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/api/sentiment/detected": { "post": { "tags": [ "Sentiment" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChatSentimentRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChatSentimentRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChatSentimentRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChatSentimentRequestDto" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/settings": { "get": { "tags": [ "Setting" ], "summary": "Get details of the settings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Setting" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/offer": { "get": { "tags": [ "Setting" ], "summary": "Get account-level offer settings.\r\nConsumed by the routing service to decide whether items should be offered to agents\r\n(vs directly assigned), the offer TTL (30-120 seconds), and whether agents can reject.\r\nDefaults are returned when no row exists for the account.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Setting" ], "summary": "Save account-level offer settings. Validates OfferTtlSeconds ∈ [30, 120].\r\nPublishes ACCOUNT_SETTINGS_CHANGED event to invalidate the routing service cache.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfferSettings" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/mailaccounts": { "get": { "tags": [ "Setting" ], "summary": "List all existing mail accounts", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IncomingServer", "in": "query", "schema": { "type": "string" } }, { "name": "IncomingLoginName", "in": "query", "schema": { "type": "string" } }, { "name": "OutgoingServer", "in": "query", "schema": { "type": "string" } }, { "name": "OutgoingLoginName", "in": "query", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccountQueryResult" } } } } } }, "post": { "tags": [ "Setting" ], "summary": "Create mail account", "requestBody": { "description": "Mail account data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/MailAccount" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/mailaccounts/{id}": { "get": { "tags": [ "Setting" ], "summary": "Get details of the mail account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Setting" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Setting" ], "summary": "Delete mail account", "parameters": [ { "name": "id", "in": "path", "description": "Mail account identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailAccount" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/workinghours": { "get": { "tags": [ "Setting" ], "summary": "List all existing working hours", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DayIndis", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "TableType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/WorkingHourTable" } }, { "name": "TableId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkingHourQueryResult" } } } } } }, "post": { "tags": [ "Setting" ], "summary": "Create working hours", "requestBody": { "description": "Working hour data array.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/workinghours/{id}": { "put": { "tags": [ "Setting" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkingHour" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Setting" ], "summary": "Delete working hour", "parameters": [ { "name": "id", "in": "path", "description": "Working hour identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkingHour" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/settings/mailaccounts/oauth/login": { "get": { "tags": [ "Setting" ], "parameters": [ { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/sip-servers": { "get": { "tags": [ "SipServer" ], "parameters": [ { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "schema": { "pattern": "^(AVAILABLE|BUSY|OFFLINE|MAINTENANCE)$", "type": "string" } }, { "name": "offset", "in": "query", "schema": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32", "default": 0 } }, { "name": "limit", "in": "query", "schema": { "maximum": 500, "minimum": 1, "type": "integer", "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SipServerQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "SipServer" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/sip-servers/{serverId}": { "get": { "tags": [ "SipServer" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SipServer" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "SipServer" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SipServerUpsertRequest" } } } }, "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "SipServer" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/sip-servers/{serverId}/activate": { "patch": { "tags": [ "SipServer" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/sip-servers/{serverId}/deactivate": { "patch": { "tags": [ "SipServer" ], "parameters": [ { "name": "serverId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/slas/policies/{id}": { "get": { "tags": [ "Sla" ], "summary": "Get details of an SLA policy", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Sla" ], "summary": "Update sla policy", "parameters": [ { "name": "id", "in": "path", "description": "Sla policy identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Sla policy data", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Sla" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/slas/policies": { "get": { "tags": [ "Sla" ], "summary": "Get list of sla policies", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "IsActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicyDataQueryResult" } } } } } }, "post": { "tags": [ "Sla" ], "summary": "Create sla policy", "requestBody": { "description": "Sla policy data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaPolicy" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/slas/breaches": { "get": { "tags": [ "Sla" ], "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedType", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "SlaType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/SlaType" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlaBreachQueryResult" } } } } } } }, "/v1/smslogs/{id}": { "get": { "tags": [ "SmsLog" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsLogQueryResult" } } } } } } }, "/v1/stages/{id}": { "get": { "tags": [ "Stage" ], "summary": "Get details of a stage", "parameters": [ { "name": "id", "in": "path", "description": "Stage identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Stage" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Stage" ], "summary": "Delete stage", "parameters": [ { "name": "id", "in": "path", "description": "Stage identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/stages": { "get": { "tags": [ "Stage" ], "summary": "List all existing stages", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "PipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StageQueryResult" } } } } } }, "post": { "tags": [ "Stage" ], "summary": "Create stage", "requestBody": { "description": "Stage data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Stage" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Stage" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Stage" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stage" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/surveys": { "get": { "tags": [ "Survey" ], "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Type", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/SurveyType" } }, { "name": "InputType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/SurveyInputType" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Survey" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Survey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Survey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Survey" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/surveys/{id}": { "get": { "tags": [ "Survey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Survey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Survey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "deleteFeedbacks", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Survey" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/surveys/feedbacks": { "get": { "tags": [ "Survey" ], "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Rate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "Data", "in": "query", "schema": { "type": "string" } }, { "name": "UserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ActorId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ActorType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/FeedbackActorType" } }, { "name": "SurveyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackResponseModelQueryResult" } } } } } } }, "/v1/surveys/{surveyId}/feedbacks/{id}": { "get": { "tags": [ "Survey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Survey" ], "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Survey" ], "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/surveys/{id}/feedbacks": { "post": { "tags": [ "Survey" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Feedback" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Feedback" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Feedback" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/surveys/removelink": { "post": { "tags": [ "Survey" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SurveyLink" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SurveyLink" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SurveyLink" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SurveyLink" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/templates/{id}": { "get": { "tags": [ "Template" ], "summary": "Get details of a template", "parameters": [ { "name": "id", "in": "path", "description": "Template identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Template" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Template" ], "summary": "Delete template", "parameters": [ { "name": "id", "in": "path", "description": "Template identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v1/templates": { "get": { "tags": [ "Template" ], "summary": "List all existing templates", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "Template", "in": "query", "schema": { "type": "string" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModelQueryResult" } } } } } }, "post": { "tags": [ "Template" ], "summary": "Create template", "requestBody": { "description": "template data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{id}": { "get": { "tags": [ "Ticket" ], "summary": "Get details of a ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Ticket" ], "summary": "Update ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Ticket data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredFieldsErrorResource" } } } } } }, "delete": { "tags": [ "Ticket" ], "summary": "Delete ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{id}/sentiment": { "get": { "tags": [ "Ticket" ], "summary": "Get the current sentiment detected for a ticket (AI sentiment classification).\r\nTicket analog of `GET /v1/chat/rooms/{roomId}/sentiment`. Returns the raw\r\nresponse object (or `null` when no sentiment has been detected yet) — NOT\r\nwrapped in `ApiResponse` — to mirror the chat sentiment endpoint and the\r\nshape the ticket FE hook consumes (reads `.category` off the body directly).", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSentimentResponse" } } } } } } }, "/v1/tickets/{id}/intents": { "get": { "tags": [ "Ticket" ], "summary": "Get the intents detected for a ticket (AI intent classification), oldest first.\r\nTicket analog of `GET /v1/chat/rooms/{roomId}/intents`. Returns the raw\r\nlist — NOT wrapped in `ApiResponse` — to mirror the chat intents endpoint\r\nand the shape the ticket FE hook consumes (iterates the array body directly).", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketIntentResponse" } } } } } } } }, "/v1/tickets/{id}/customer-context": { "get": { "tags": [ "Ticket" ], "summary": "Get the current customer context generated for a ticket (AI customer-context).\r\nTicket analog of `GET /v1/chat/rooms/{roomId}/customer-context`. Returns the\r\nraw response object (or `null` when none has been generated yet) — NOT wrapped\r\nin `ApiResponse` — to mirror the chat customer-context endpoint and the shape\r\nthe ticket FE hook consumes (reads `.summary`/`.recommendation` directly).", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCustomerContextResponse" } } } } } } }, "/v1/tickets/{id}/summary": { "get": { "tags": [ "Ticket" ], "summary": "Get the current AI-generated summary of a ticket. Returns the raw response object\r\n(or `null` when no summary has been generated yet) — NOT wrapped in\r\n`ApiResponse` — to mirror the other ticket AI endpoints and the shape the\r\nticket FE hook consumes (reads `.summary`/`.updatedAt` off the body directly).", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSummaryResponse" } } } } } } }, "/v1/tickets/{id}/summary/refresh": { "post": { "tags": [ "Ticket" ], "summary": "Queue an on-demand refresh of a ticket's AI summary. Publishes a\r\n`TicketSummaryRequestEvent` to `ticket.summary-requests` for the AI\r\nsummary-service, throttled by a per-ticket 30s Redis SETNX cooldown so agents\r\n(across pods) cannot flood the AI side. Returns the raw response object — NOT\r\nwrapped in `ApiResponse` — to mirror the other ticket AI endpoints:\r\n`{queued:true}` or `{queued:false, cooldownSeconds:N}`.", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSummaryRefreshResponse" } } } } } } }, "/v1/tickets/{id}/suggestions": { "get": { "tags": [ "Ticket" ], "summary": "Get the current copilot suggestion snapshot for a ticket, proxied from\r\ncopilot-service. Ticket analog of `GET /v1/chat/rooms/{roomId}/suggestions`.\r\nReturns the raw DTO — NOT wrapped in `ApiResponse` — to mirror the chat\r\nsuggestions endpoint and the shape the ticket FE hook consumes (reads\r\n`.suggestions` off the body directly).\r\nFAIL-OPEN: copilot-service being unconfigured, slow or down yields an empty\r\nsnapshot (200 with an empty list), never an error.", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoomSuggestionsDto" } } } } } } }, "/v1/tickets/{id}/suggestions/regenerate": { "post": { "tags": [ "Ticket" ], "summary": "Queue an on-demand regeneration of the ticket's AI suggestion (IDT-2012). Ticket\r\nanalog of `POST /v1/chat/rooms/{roomId}/suggestions/regenerate`: throttled by a\r\nper-ticket 30s Redis SETNX cooldown so agents (across pods) cannot flood the copilot\r\nside. The fresh suggestion reaches the dashboard through the normal\r\n`newTicketSuggestion` push. Returns the raw response object — NOT wrapped in\r\n`ApiResponse` — mirroring the chat endpoint:\r\n`{queued:true}` or `{queued:false, cooldownSeconds:N}`.", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK" } } } }, "/v1/tickets/{id}/suggestions/{suggestionId}/feedback": { "post": { "tags": [ "Ticket" ], "summary": "Ticket analog of `POST /v1/chat/rooms/{roomId}/suggestions/{suggestionId}/feedback` —\r\nqueues the current agent's approval (👍) or disapproval (👎) of one AI suggestion.\r\n`rating` is `up` | `down` | `none` (none withdraws).", "description": "ASYNCHRONOUS: see the chat endpoint's remarks. `202` means accepted for delivery,\r\nnot stored; the ownership check runs in the consumer, so there is no `404` here.", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "suggestionId", "in": "path", "description": "Suggestion row id, taken from the suggestion payload.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "The vote.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SuggestionFeedbackRequestDto" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/tickets": { "get": { "tags": [ "Ticket" ], "summary": "List all existing tickets", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "PipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "Subject", "in": "query", "schema": { "type": "string" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "Source", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/TicketSource" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketStatus" } } }, { "name": "Priority", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/PriorityType" } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CompanyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CreatedUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "OwnerIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "OwnerGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FollowerIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "IsSpam", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "FromStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromDueDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDueDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "ToNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "FromOpenTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToOpenTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromPendingTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToPendingTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SlaId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "MergeId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IncludeMerged", "in": "query", "schema": { "type": "boolean" } }, { "name": "CustomFields", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataFieldFilter" }, "nullable": true } } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "MinCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ChatId", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Ticket" ], "summary": "Create ticket", "requestBody": { "description": "Ticket data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Ticket" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Ticket" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/search": { "get": { "tags": [ "Ticket" ], "summary": "Performs a text search on tickets and returns the matching results", "parameters": [ { "name": "Query", "in": "query", "required": true, "schema": { "minLength": 3, "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "SearchInActivities", "in": "query", "description": "Executes the search in activities (notes, emails, calls, meetings, etc.)", "schema": { "type": "boolean" } }, { "name": "SearchType", "in": "query", "description": "Search type: Smart (default), Exact, Fuzzy

Enum values:

", "schema": { "$ref": "#/components/schemas/SearchType" } }, { "name": "Fuzziness", "in": "query", "description": "Fuzzy tolerance: None (default), Auto, Low (1), High (2)

Enum values:

", "schema": { "$ref": "#/components/schemas/FuzzinessTolerance" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponseModelQueryResult" } } } } } } }, "/v1/tickets/logs": { "get": { "tags": [ "Ticket" ], "summary": "Returns the ticket logs of a ticket", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "TicketId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketLogResponseModelQueryResult" } } } } } }, "post": { "tags": [ "Ticket" ], "summary": "Adds a log to the ticket", "requestBody": { "description": "Ticket log data", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TicketLog" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TicketLog" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketLog" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TicketLog" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketLogResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/logs/{id}": { "put": { "tags": [ "Ticket" ], "summary": "Update ticket log", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketLog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{id}/files": { "get": { "tags": [ "Ticket" ], "summary": "Returns the files of a ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Ticket" ], "summary": "Adds files to the ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "resource": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File data" } } }, "encoding": { "resource": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileResponseModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/files/{id}": { "delete": { "tags": [ "Ticket" ], "summary": "Delete ticket file", "parameters": [ { "name": "id", "in": "path", "description": "Ticket file identifier", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{id}/mergedtickets": { "get": { "tags": [ "Ticket" ], "summary": "Returns the merged tickets of the ticket", "parameters": [ { "name": "id", "in": "path", "description": "Ticket identifier", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "PipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "StageIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "Subject", "in": "query", "schema": { "type": "string" } }, { "name": "Content", "in": "query", "schema": { "type": "string" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "Source", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/TicketSource" } }, { "name": "Status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketStatus" } } }, { "name": "Priority", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/PriorityType" } }, { "name": "ContactId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CompanyId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "CreatedUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "OwnerIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "OwnerGroupId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FollowerIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "CategoryIds", "in": "query", "schema": { "maxLength": 128, "type": "string" } }, { "name": "IsSpam", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "description": "'yyyy-MM-ddTHH:mm:ss.000Z'", "schema": { "type": "string" } }, { "name": "FromStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromDueDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDueDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToUpdatedDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToClosingDate", "in": "query", "schema": { "type": "string" } }, { "name": "FromNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "ToNextSlaBreach", "in": "query", "schema": { "type": "string" } }, { "name": "FromOpenTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToOpenTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromPendingTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ToPendingTimeSec", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SlaId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "MergeId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "IncludeMerged", "in": "query", "schema": { "type": "boolean" } }, { "name": "CustomFields", "in": "query", "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DataFieldFilter" }, "nullable": true } } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "MinCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "MaxCsatRate", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ChatId", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/changeorder": { "put": { "tags": [ "Ticket" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "oldStageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "newStageId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "oldOrderNo", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "newOrderNo", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/convertdeal": { "put": { "tags": [ "Ticket" ], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "pipelineId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "stageId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deal" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/insertbulk": { "post": { "tags": [ "Ticket" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketResponseModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketResponseModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketResponseModel" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketResponseModel" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{ticketId}/timeentries": { "get": { "tags": [ "Ticket" ], "summary": "Gets all time entries", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Billable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "sortCol", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "post": { "tags": [ "Ticket" ], "summary": "Create a time entry", "parameters": [ { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TimeEntryCreateModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryCreateModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeEntryCreateModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TimeEntryCreateModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{ticketId}/timeentries/{id}": { "get": { "tags": [ "Ticket" ], "summary": "Gets a time entry", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Ticket" ], "summary": "Edits a time entry", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Ticket" ], "summary": "Deletes a time entry", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{ticketId}/timeentries/{id}/reset": { "put": { "tags": [ "Ticket" ], "summary": "Reset the timer of a time entry", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ticketId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/tickets/{id}/automationRunLogs": { "get": { "tags": [ "Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationRunLogsByRecordQueryResult" } } } } } } }, "/v1/tickets/{id}/routingRunLogs": { "get": { "tags": [ "Ticket" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingRunLogQueryResult" } } } } } } }, "/v1/todos/{id}": { "get": { "tags": [ "Todo" ], "summary": "Get details of a todo", "parameters": [ { "name": "id", "in": "path", "description": "Todo identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Todo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "Todo" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Todo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "Todo" ], "summary": "Delete todo", "parameters": [ { "name": "id", "in": "path", "description": "Todo identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Todo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/todos": { "get": { "tags": [ "Todo" ], "summary": "List all existing todos", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Notes", "in": "query", "schema": { "type": "string" } }, { "name": "OwnerIds", "in": "query", "schema": { "type": "string" } }, { "name": "IsNotified", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsEmailSent", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsFinished", "in": "query", "schema": { "type": "boolean" } }, { "name": "IsPersonal", "in": "query", "schema": { "type": "boolean" } }, { "name": "ReminderType", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReminderType" } } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TodoQueryResult" } } } } } }, "post": { "tags": [ "Todo" ], "summary": "Create todo", "requestBody": { "description": "Todo data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Todo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Todo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Todo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Todo" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Todo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/{id}": { "get": { "tags": [ "User" ], "summary": "Get details of a single user", "parameters": [ { "name": "id", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "User" ], "summary": "Update user", "parameters": [ { "name": "id", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "User data.", "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "User" ], "summary": "Delete user", "parameters": [ { "name": "id", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/me": { "get": { "tags": [ "User" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/me/hash": { "get": { "tags": [ "User" ], "parameters": [ { "name": "chatWidgetId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserHashModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users": { "get": { "tags": [ "User" ], "summary": "List all existing users", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DisplayName", "in": "query", "schema": { "type": "string" } }, { "name": "Nickname", "in": "query", "schema": { "type": "string" } }, { "name": "Email", "in": "query", "schema": { "type": "string" } }, { "name": "PhoneNumber", "in": "query", "schema": { "type": "string" } }, { "name": "Department", "in": "query", "schema": { "type": "string" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "IncludeSettings", "in": "query", "schema": { "type": "boolean" } }, { "name": "Q", "in": "query", "schema": { "type": "string" } }, { "name": "Fields", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } }, { "name": "isExport", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponseModelQueryResult" } } } } } }, "post": { "tags": [ "User" ], "summary": "Create user", "requestBody": { "description": "User data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserPayloadModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPayloadModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPayloadModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserPayloadModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/{id}/password": { "put": { "tags": [ "User" ], "summary": "Update user's password", "parameters": [ { "name": "id", "in": "path", "description": "User identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "Password data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangePasswordModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/timezones": { "get": { "tags": [ "User" ], "summary": "List all existing timezones", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimezoneQueryResult" } } } } } } }, "/v1/users/insertbulk": { "post": { "tags": [ "User" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertBulkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/bulk-action": { "post": { "tags": [ "User" ], "summary": "IDT-934: owner-only bulk operations over a user selection — passivate, change brand, change profile,\r\nchange group. Each user is processed independently; per-user failures are reported in the response and\r\ndo not abort the batch (not transactional). Action payloads reuse the validated single-user paths\r\n(Save / AddUserToProfile / UserChangeGroups), so the existing assignment and audit rules still apply.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BulkUserActionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BulkUserActionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BulkUserActionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BulkUserActionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUserActionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/users/{id}/availability": { "get": { "tags": [ "User" ], "summary": "Get a user's auto-assign availability", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailabilityQueryResult" } } } } } }, "put": { "tags": [ "User" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SaveUserAvailabilityModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SaveUserAvailabilityModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SaveUserAvailabilityModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SaveUserAvailabilityModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailability" } } } } } } }, "/v1/users/availability": { "get": { "tags": [ "User" ], "summary": "Get all users' auto-assign availabilities", "parameters": [ { "name": "linkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "departmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailabilityQueryResult" } } } } } } }, "/v1/users/state": { "get": { "tags": [ "User" ], "summary": "Get all users' states and duration(minute) on current state.", "parameters": [ { "name": "linkedType", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailabilityQueryResult" } } } } } } }, "/v1/users/autoassignlimits": { "put": { "tags": [ "User" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/UserAutoAssignLimits" } } }, "application/json": { "schema": { "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/UserAutoAssignLimits" } } }, "text/json": { "schema": { "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/UserAutoAssignLimits" } } }, "application/*+json": { "schema": { "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/UserAutoAssignLimits" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailability" } } } } } } }, "/v1/users/availability/overview": { "get": { "tags": [ "User" ], "summary": "Get all users with states and availabilities.", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DisplayName", "in": "query", "schema": { "type": "string" } }, { "name": "Department", "in": "query", "schema": { "type": "string" } }, { "name": "GroupIds", "in": "query", "schema": { "type": "string" } }, { "name": "State", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAvailabilityOverviewResponseModelQueryResult" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResourceQueryResult" } } } } } } }, "/v1/usergroups/{id}": { "get": { "tags": [ "UserGroup" ], "summary": "Get details of an user group", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "UserGroup" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "UserGroup" ], "summary": "Delete an user group", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/usergroups": { "get": { "tags": [ "UserGroup" ], "summary": "Get list of user groups", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "Name", "in": "query", "schema": { "type": "string" } }, { "name": "DepartmentId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "DepartmentScope", "in": "query", "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`.", "schema": { "$ref": "#/components/schemas/DepartmentPageSelection" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupQueryResult" } } } } } }, "post": { "tags": [ "UserGroup" ], "summary": "Create user group", "requestBody": { "description": "User group data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserGroup" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/usergroups/{id}/users": { "get": { "tags": [ "UserGroup" ], "summary": "Get users of an user group", "parameters": [ { "name": "id", "in": "path", "description": "User group identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupUser" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/usergroups/{id}/users/order": { "put": { "tags": [ "UserGroup" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroupUser" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/userratings/{id}": { "get": { "tags": [ "UserRating" ], "summary": "Get details of a rating", "parameters": [ { "name": "id", "in": "path", "description": "Rating identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRating" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "put": { "tags": [ "UserRating" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { } }, "application/json": { "schema": { } }, "text/json": { "schema": { } }, "application/*+json": { "schema": { } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRating" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } }, "delete": { "tags": [ "UserRating" ], "summary": "Delete rating", "parameters": [ { "name": "id", "in": "path", "description": "Rating identifier.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRating" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/userratings": { "get": { "tags": [ "UserRating" ], "summary": "List all existing user ratings", "parameters": [ { "name": "Id", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "LinkedTable", "in": "query", "description": "Infoset data objects

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/Table" } }, { "name": "CreatedUserId", "in": "query", "schema": { "type": "integer", "format": "int64" } }, { "name": "FromDate", "in": "query", "schema": { "type": "string" } }, { "name": "ToDate", "in": "query", "schema": { "type": "string" } }, { "name": "ViewType", "in": "query", "description": "

Enum values:

Enum values:

", "schema": { "$ref": "#/components/schemas/ViewType" } }, { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ItemsPerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "ReturnTotalItems", "in": "query", "schema": { "type": "boolean" } }, { "name": "sortCol", "in": "query", "schema": { "type": "string" } }, { "name": "sortDir", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRatingQueryResult" } } } } } }, "post": { "tags": [ "UserRating" ], "summary": "Create rating", "requestBody": { "description": "Rating data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserRating" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRating" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRating" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRating" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRating" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/userstate/{userId}": { "get": { "tags": [ "UserState" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserStateType" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResource" } } } } } } }, "/v1/userstate/newstate": { "post": { "tags": [ "UserState" ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserNewState" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserNewState" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserNewState" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserNewState" } } } }, "responses": { "200": { "description": "OK" } } } }, "/v1/userstate/previousavailabilities": { "get": { "tags": [ "UserState" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserAvailability" } } } } } } } } }, "components": { "schemas": { "AccountPlan": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "planId": { "type": "integer", "format": "int32" }, "planResourceId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "description": "Başlama zamanı, demo açılan müşteri için PlanResourceItem daki demo_days alanından bakılarak hesaplanacak", "format": "date-time" }, "expirationDate": { "type": "string", "description": "hesap kullanım sonlanma tarihi", "format": "date-time" }, "renewalDate": { "type": "string", "description": "hesap yenilenme tarihi", "format": "date-time", "nullable": true }, "name": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "nullable": true }, "billingUnit": { "$ref": "#/components/schemas/BillingUnit" }, "billingRecurs": { "type": "integer", "description": "Faturalandırma her 1 ayda, yada her 1 yılda", "format": "int32" }, "color": { "type": "string", "nullable": true }, "planResource": { "$ref": "#/components/schemas/InfosetPlanResource" }, "addUsers": { "type": "integer", "format": "int32" }, "addAgents": { "type": "integer", "format": "int32" }, "addExtNumbers": { "type": "integer", "format": "int32" }, "addChatWidgets": { "type": "integer", "format": "int32" }, "addMailAccounts": { "type": "integer", "format": "int32" }, "addDesks": { "type": "integer", "format": "int32" }, "addGsmFct": { "type": "integer", "description": "GSM FCT slots", "format": "int32" }, "freeUsers": { "type": "integer", "format": "int32" }, "freeAgents": { "type": "integer", "format": "int32" }, "freeExtNumbers": { "type": "integer", "format": "int32" }, "freeChatWidgets": { "type": "integer", "format": "int32" }, "freeMailAccounts": { "type": "integer", "format": "int32" }, "freeGsmFct": { "type": "integer", "format": "int32" }, "freeDesks": { "type": "integer", "format": "int32" }, "freeConcurrentCalls": { "type": "integer", "format": "int32" }, "apps": { "type": "string", "nullable": true }, "custom": { "$ref": "#/components/schemas/AccountPlanCustomData" } }, "additionalProperties": false }, "AccountPlanCustomData": { "type": "object", "properties": { "extras": { "type": "array", "items": { "$ref": "#/components/schemas/AccountPlanExtraBillableItem" }, "nullable": true } }, "additionalProperties": false }, "AccountPlanExtraBillableItem": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "AccountSettings": { "type": "object", "properties": { "language": { "maxLength": 10, "type": "string", "nullable": true }, "timeZoneId": { "type": "integer", "format": "int32" }, "passiveOnDisconnect": { "type": "boolean" }, "unassignChatsOnDisconnect": { "type": "boolean" }, "chatUnassignMinute": { "type": "integer", "format": "int64" }, "allowedExtensions": { "type": "string", "nullable": true }, "offerEnabled": { "type": "boolean" }, "offerTtlSeconds": { "type": "integer", "format": "int32" }, "rejectAllowed": { "type": "boolean" } }, "additionalProperties": false }, "AcdType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ActionEventType": { "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "AddProfileUserRequest": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Announcement": { "required": [ "departmentIds", "message", "messageType", "name", "sendType", "startTime", "status", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "message": { "minLength": 1, "type": "string" }, "visibleTo": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/AnnouncementType" }, "status": { "type": "boolean" }, "messageType": { "$ref": "#/components/schemas/AnnouncementMessageType" }, "sendType": { "$ref": "#/components/schemas/AnnouncementSendType" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AnnouncementMessageType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "AnnouncementReadLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "announcementId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "readAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AnnouncementReadLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementReadLog" }, "nullable": true } }, "additionalProperties": false }, "AnnouncementReadResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/AnnouncementReadLog" } }, "additionalProperties": false }, "AnnouncementResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/Announcement" } }, "additionalProperties": false }, "AnnouncementResponseModel": { "required": [ "departmentIds", "message", "messageType", "name", "sendType", "startTime", "status", "type" ], "type": "object", "properties": { "readAt": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "message": { "minLength": 1, "type": "string" }, "visibleTo": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "type": { "$ref": "#/components/schemas/AnnouncementType" }, "status": { "type": "boolean" }, "messageType": { "$ref": "#/components/schemas/AnnouncementMessageType" }, "sendType": { "$ref": "#/components/schemas/AnnouncementSendType" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AnnouncementResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AnnouncementResponseModel" }, "nullable": true } }, "additionalProperties": false }, "AnnouncementSendType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "AnnouncementType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ArticleStats": { "type": "object", "properties": { "views": { "type": "integer", "description": "Number of views", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AudioFile": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "sizeKB": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "departmentIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AudioFileFolder": { "type": "object", "properties": { "folderName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AudioFileFolderQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AudioFileFolder" }, "nullable": true } }, "additionalProperties": false }, "AudioFileQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AudioFile" }, "nullable": true } }, "additionalProperties": false }, "AuditLogResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "actorType": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/AuditLogType" }, "event": { "type": "string", "nullable": true }, "targetType": { "type": "string", "nullable": true }, "result": { "type": "string", "nullable": true }, "eventPrevData": { "type": "string", "nullable": true }, "eventNewData": { "type": "string", "nullable": true }, "recordId": { "type": "string", "nullable": true }, "recordName": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "sessionId": { "type": "string", "nullable": true }, "retentionClass": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "apiKeyId": { "type": "integer", "format": "int64", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true }, "prevHash": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "AuditLogResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditLogResponseModel" }, "nullable": true } }, "additionalProperties": false }, "AuditLogType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "AuthorizedAction": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "AutoCloseConfigModel": { "type": "object", "properties": { "chatbotWarningEnabled": { "type": "boolean", "description": "Chatbot odaları için uyarı gönderilsin mi?\r\nfalse ise direkt close time'a kadar bekler" }, "chatbotWarningTimeMinutes": { "type": "integer", "description": "Chatbot odaları için kaç dakika sonra uyarı gönderilir\r\nChatbotWarningEnabled = true ise zorunlu", "format": "int32", "nullable": true }, "chatbotWarningMessage": { "type": "string", "description": "Chatbot uyarı mesajı içeriği\r\nnull = default translation kullan", "nullable": true }, "chatbotCloseEnabled": { "type": "boolean", "description": "Chatbot odaları otomatik kapatılsın mı?\r\nfalse ise tüm chatbot auto-close disabled" }, "chatbotCloseTimeMinutes": { "type": "integer", "description": "Chatbot odaları kaç dakika sonra kapatılır\r\nChatbotCloseEnabled = true ise zorunlu", "format": "int32", "nullable": true }, "chatbotCloseWithoutMessage": { "type": "boolean", "description": "Chatbot odaları kapatılırken mesaj gönderilmeden mi kapatılsın?\r\ntrue = mesaj gönderme (ChatbotCloseMessage ignore edilir)\r\nfalse = mesaj gönder (null ise default translation)" }, "chatbotCloseMessage": { "type": "string", "description": "Chatbot kapanma mesajı içeriği\r\nnull = default translation kullan\r\nChatbotCloseWithoutMessage = true ise ignore edilir", "nullable": true }, "noBotWarningEnabled": { "type": "boolean", "description": "Bot olmayan odalar için uyarı gönderilsin mi?\r\nfalse ise direkt close time'a kadar bekler" }, "noBotWarningTimeMinutes": { "type": "integer", "description": "Bot olmayan odalar için kaç dakika sonra uyarı gönderilir\r\nNoBotWarningEnabled = true ise zorunlu", "format": "int32", "nullable": true }, "noBotWarningMessage": { "type": "string", "description": "Bot olmayan odalar uyarı mesajı\r\nnull = default translation kullan", "nullable": true }, "noBotCloseEnabled": { "type": "boolean", "description": "Bot olmayan odalar otomatik kapatılsın mı?\r\nfalse ise no-bot auto-close disabled" }, "noBotCloseTimeMinutes": { "type": "integer", "description": "Bot olmayan odalar kaç dakika sonra kapatılır\r\nNoBotCloseEnabled = true ise zorunlu", "format": "int32", "nullable": true }, "noBotCloseWithoutMessage": { "type": "boolean", "description": "Bot olmayan odalar kapatılırken mesaj gönderilmeden mi kapatılsın?\r\ntrue = mesaj gönderme (NoBotCloseMessage ignore edilir)\r\nfalse = mesaj gönder (null ise default translation)" }, "noBotCloseMessage": { "type": "string", "description": "Bot olmayan odalar kapanma mesajı\r\nnull = default translation kullan\r\nNoBotCloseWithoutMessage = true ise ignore edilir", "nullable": true } }, "additionalProperties": false, "description": "Auto-close configuration model for chatbots\r\nSerialized to JSON and stored in AUTO_CLOSE_CONFIG column" }, "Automation": { "required": [ "automationActions", "automationData", "automationFilters" ], "type": "object", "properties": { "automationData": { "$ref": "#/components/schemas/AutomationData" }, "automationFilters": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationFilter" } }, "automationActions": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationAction" } } }, "additionalProperties": false }, "AutomationAction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "automationId": { "type": "integer", "format": "int64" }, "actionType": { "type": "string", "description": "Automation action type", "nullable": true }, "actionValue": { "type": "string", "description": "Eylem içeriği", "nullable": true } }, "additionalProperties": false }, "AutomationData": { "required": [ "eventType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" }, "departmentIds": { "type": "string", "description": "Comma-separated department ids this automation belongs to (Çoklu Marka). Required (at least one);\r\nthe automation only runs on records of these departments.", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "eventType": { "$ref": "#/components/schemas/ActionEventType" }, "status": { "type": "integer", "description": "=0 pasif, =1 aktif", "format": "int32" }, "workingHourType": { "type": "integer", "description": "Çalışma Saatleri Seçeneği\r\n0:Yok,\r\n1: Sistem Ayarları Mesai Saati Kullan\r\n2: Özel Mesai Saati Kullan\r\n3: Mesai saatleri dışı", "format": "int32" }, "runCount": { "type": "integer", "description": "Run count for the last 2 weeks", "format": "int32" }, "timeBased": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "AutomationDataQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationData" }, "nullable": true } }, "additionalProperties": false }, "AutomationFilter": { "required": [ "filterLevelOperation", "filterOperation", "filterPrefix" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "automationId": { "type": "integer", "format": "int64" }, "filterType": { "type": "string", "description": "\"condition\" or \"event\"", "nullable": true }, "filterColumn": { "type": "string", "nullable": true }, "filterPrefix": { "$ref": "#/components/schemas/QueryPrefix" }, "filterValue": { "type": "string", "nullable": true }, "filterOperation": { "$ref": "#/components/schemas/QueryOperator" }, "filterLevel": { "type": "integer", "format": "int32" }, "filterLevelOperation": { "$ref": "#/components/schemas/QueryOperator" }, "requirePresenceInDiff": { "type": "boolean" } }, "additionalProperties": false }, "AutomationRunLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "automationId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "runAt": { "type": "string", "format": "date-time" }, "meta": { "nullable": true }, "linkedId": { "type": "integer", "format": "int64" }, "linkedName": { "type": "string", "nullable": true }, "linkedType": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AutomationRunLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRunLog" }, "nullable": true } }, "additionalProperties": false }, "AutomationRunLogsByRecord": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "automationId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "automationName": { "type": "string", "nullable": true }, "automationDescription": { "type": "string", "nullable": true }, "runAt": { "type": "string", "format": "date-time" }, "linkedId": { "type": "integer", "format": "int64" }, "linkedType": { "type": "integer", "format": "int32" }, "isTimeBased": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AutomationRunLogsByRecordQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/AutomationRunLogsByRecord" }, "nullable": true } }, "additionalProperties": false }, "BillingUnit": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "BulkUserAction": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "Owner-only bulk operations applied to a selection of users (IDT-934).

Enum values:

", "format": "int32" }, "BulkUserActionRequest": { "required": [ "action", "userIds" ], "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "action": { "$ref": "#/components/schemas/BulkUserAction" }, "value": { "type": "string", "description": "Action payload: comma-separated department ids (ChangeBrand), a single profile id (ChangeProfile),\r\ncomma-separated group ids (ChangeGroup). Ignored for Passivate.", "nullable": true } }, "additionalProperties": false }, "BulkUserActionResponse": { "type": "object", "properties": { "succeeded": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUserActionResult" }, "nullable": true } }, "additionalProperties": false }, "BulkUserActionResult": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "success": { "type": "boolean" }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CallCenterQueue": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Kuyruk Adı" }, "virtualExtNumber": { "type": "string", "description": "Sanal Dahili Numarası", "nullable": true }, "acdType": { "$ref": "#/components/schemas/AcdType" }, "maxRingTime": { "type": "integer", "description": "Sn cinsinden Agent Telefon Çaldırma Süresi", "format": "int32" }, "queueTimeout": { "type": "integer", "description": "Sn cinsinden Maks Kuyrukta Bekleme Süresi", "format": "int32" }, "noAnswerDestination": { "type": "string", "description": "Kuyruğa Bağlantı Kurulamadığında Çağrının Gönderileceği Sanal Dahili No (Aktif Agent Olmadığında veya Maks Kuyruk\r\nSüresi Aşıldığında)", "nullable": true }, "queueMusicWavFiles": { "type": "string", "description": "Cingle Müzik Dosya Listesi, ; ile ayrılmış şekilde", "nullable": true }, "queuePositionStatus": { "type": "integer", "description": "Kuyrukta Beklerken Kuyruk Numarası Söyleme Durumu 0:Yok, 1:Var", "format": "int32" }, "queuePositionPeriod": { "type": "integer", "description": "Kuyruk Numarası Söyleme Periyodu", "format": "int32" }, "queuePositionWavPrefix": { "type": "string", "description": "Kuyruk numarası wav dosya başı (kuyruk[sirano].wav formatında olacak bu alana sadece kuyruk wav dosya başlangıcı\r\nyazılacak)", "nullable": true }, "queueVoiceMailDtmf": { "type": "string", "description": "Sesli Mesaj Bırakma Tuş Seçeneği Yok yada 0,1..9", "nullable": true }, "transferMusicWavFile": { "type": "string", "description": "Çağrı Aktarıldığında Agentın Telefonu Açmasını Beklerken Dinletilecek Müzik Dosyası", "nullable": true }, "agentQueueLoginType": { "type": "integer", "description": "Agent'in Kuyruğa Login Seçeneği 0:Agent Register Olduğunda, 1:Agent Login Olduğunda", "format": "int32" }, "agentRestTime": { "type": "integer", "description": "Sn cinsinden Agent Çağrı Sonrası Dinlenme Süresi", "format": "int32" }, "agentIds": { "type": "string", "description": "Bağlı agent listesi \",\" ile ayrılmış şekilde, sırası önemli, öncelikli olan agent ilk sırada verilmelidir", "nullable": true }, "survey": { "$ref": "#/components/schemas/Survey" }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CallCenterQueueResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "virtualExtNumber": { "type": "string", "nullable": true }, "acdType": { "$ref": "#/components/schemas/AcdType" }, "maxRingTime": { "type": "integer", "format": "int32" }, "queueTimeout": { "type": "integer", "format": "int32" }, "noAnswerDestination": { "type": "string", "nullable": true }, "queueMusicWavFiles": { "type": "string", "nullable": true }, "agentIds": { "type": "string", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "CallCenterQueueResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallCenterQueueResponseModel" }, "nullable": true } }, "additionalProperties": false }, "CallDestinationType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CallDirectionType": { "enum": [ 0, 1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CallLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "userRatingId": { "type": "integer", "format": "int64", "nullable": true }, "userRatingScore": { "type": "number", "format": "double", "nullable": true }, "visitorFeedbackId": { "type": "integer", "format": "int64", "nullable": true }, "visitorFeedbackRate": { "type": "number", "format": "double", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "callDuration": { "type": "integer", "description": "AccountId+Api Key - HMACSHA256", "format": "int32" }, "ringDuration": { "type": "integer", "format": "int32" }, "sourceType": { "$ref": "#/components/schemas/CallSourceType" }, "sourceId": { "type": "integer", "format": "int64" }, "destinationType": { "$ref": "#/components/schemas/CallDestinationType" }, "destinationId": { "type": "integer", "format": "int64" }, "eventType": { "$ref": "#/components/schemas/CallStatus" }, "callDirection": { "$ref": "#/components/schemas/CallDirectionType" }, "recordStatus": { "type": "integer", "format": "int32" }, "callerName": { "type": "string", "description": "Çağrıyı Başlatan İsim, Outsource hizmeti sunan firmalarda \"Aranan Firma Adı\" loglanıyor", "nullable": true }, "callerNumber": { "type": "string", "description": "Çağrıyı Başlatan Numara, Gelen Çağrıda Caller ID, Giden Çağrıda Arama Yapan Hattın Numarası", "nullable": true }, "calledName": { "type": "string", "description": "Çağrıyı Hedefleyen İsim", "nullable": true }, "calledNumber": { "type": "string", "description": "Çağrıyı Hedefleyen Numara, Gelen Çağrıda Çağrıyı Karşılayan Kanalın Numarası(IVR, Dahili No gibi), Giden Çağrıda Aranılan Numara", "nullable": true }, "dialedNumber": { "type": "string", "description": "Çağrı başlatırken tuşlanan numara", "nullable": true }, "dtmf": { "type": "string", "description": "Gelen veya Giden Çağrıda müşterinin tuşladığı numaralar", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" }, "notes": { "type": "string", "nullable": true }, "directory": { "type": "string", "nullable": true }, "sourceIpAddress": { "type": "string", "nullable": true }, "destinationIpAddress": { "type": "string", "nullable": true }, "s3BucketName": { "type": "string", "nullable": true }, "s3Key": { "type": "string", "nullable": true }, "contactId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64" }, "view": { "type": "integer", "format": "int32" }, "listen": { "type": "integer", "format": "int32" }, "deleted": { "type": "integer", "format": "int32" }, "saveas": { "type": "integer", "format": "int32" }, "tagIds": { "type": "string", "nullable": true }, "linkedTicketIds": { "type": "string", "description": "Comma separated list of ticket ids", "nullable": true }, "linkedDealIds": { "type": "string", "description": "Comma separated list of deal ids", "nullable": true } }, "additionalProperties": false }, "CallLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallLog" }, "nullable": true } }, "additionalProperties": false }, "CallSourceType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CallStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CallTag": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "minLength": 1, "type": "string" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Category": { "required": [ "departmentIds", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 60, "minLength": 1, "type": "string" }, "color": { "maxLength": 16, "type": "string", "nullable": true }, "pipelineIds": { "maxLength": 64, "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CategoryQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Category" }, "nullable": true } }, "additionalProperties": false }, "ChangePasswordModel": { "required": [ "newPassword" ], "type": "object", "properties": { "currentPassword": { "type": "string", "nullable": true }, "newPassword": { "maxLength": 32, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ChannelType": { "enum": [ 1, 2, 3, 4, 5, 8, 10, 11, 13, 14, 15, 16 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ChatCustomerContextRequestDto": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "messageId": { "type": "string", "nullable": true }, "context": { "$ref": "#/components/schemas/CustomerContextPayloadDto" }, "generatedAt": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Wire envelope for the `POST /api/customer-context/detected` internal endpoint.\r\nMirrors the Kafka `ChatCustomerContextEvent` contract (zod\r\n`ChatCustomerContextEventSchema` in the infoset-ai-customer-context repo); JSON is camelCase." }, "ChatDesk": { "type": "object", "properties": { "_id": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatHistoryResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/ChatMessageItem" } }, "additionalProperties": false }, "ChatHistoryResponseQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatHistoryResponse" }, "nullable": true } }, "additionalProperties": false }, "ChatHomePage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "enabled": { "type": "boolean" }, "logo": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "subtitle": { "type": "string", "nullable": true }, "chatStarterTitle": { "type": "string", "nullable": true }, "chatStarterSubtitle": { "type": "string", "nullable": true }, "desk": { "type": "string", "nullable": true }, "widgets": { "type": "array", "items": { "$ref": "#/components/schemas/ChatHomepageWidget" }, "nullable": true } }, "additionalProperties": false }, "ChatHomepageWidget": { "type": "object", "properties": { "component": { "type": "string", "nullable": true }, "props": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatIntentDto": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Intent classification result (label + confidence) carried by\r\nInfoset.Types.Models.InternalApi.ChatIntentRequestDto. Confidence is an integer 0–100." }, "ChatIntentRequestDto": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "messageId": { "type": "string", "nullable": true }, "intent": { "$ref": "#/components/schemas/ChatIntentDto" }, "detectedAt": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Wire envelope for the future `POST /api/intent/detected` internal endpoint.\r\nMirrors the Kafka `ChatIntentEvent` contract (zod\r\n`ChatIntentEventSchema` in the infoset-ai-intent repo); JSON is camelCase." }, "ChatMessageItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "departmentId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "channel": { "$ref": "#/components/schemas/ChannelType" }, "channelName": { "type": "string", "nullable": true }, "channelId": { "type": "integer", "format": "int64", "nullable": true }, "channelData": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "isFromAgent": { "type": "integer", "description": "0:visitor, 1:agent, 2:chatbot\r\n4:gen-ai (see ChatUserType.GenAi; 3 is skipped, it is ChatClosedActorType.System)", "format": "int32" }, "aiSourceType": { "type": "integer", "description": "Provenance of the message text (`AiSourceType`), or `null` for\r\n\"never evaluated by the AI pipeline\" — every human and RiveScript message.\r\nIndependent of Infoset.Types.Models.Items.Chat.ChatMessageItem.IsFromAgent: neither substitutes for the other.", "format": "int32", "nullable": true }, "fromUser": { "type": "string", "description": "Message sender", "nullable": true }, "visitor": { "type": "string", "nullable": true }, "agent": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "fileUrls": { "type": "string", "nullable": true }, "sourceLang": { "type": "string", "nullable": true }, "targetLang": { "type": "string", "nullable": true }, "logTime": { "type": "string", "format": "date-time" }, "isNote": { "type": "integer", "description": "1: mention, 0: chat message", "format": "int32" }, "isEdited": { "type": "integer", "format": "int32" }, "isDeleted": { "type": "integer", "format": "int32" }, "readAt": { "type": "string", "format": "date-time", "nullable": true }, "replyToId": { "type": "string", "nullable": true }, "reaction": { "type": "string", "description": "Stored separately so a reaction does not masquerade as an edited or additional message.", "nullable": true }, "failedReason": { "type": "string", "nullable": true }, "failedCategory": { "type": "string", "nullable": true }, "mentionedUserIds": { "type": "string", "nullable": true }, "isTranslated": { "type": "integer", "format": "int32" }, "translatedContent": { "type": "string", "nullable": true }, "contactId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "assignedTo": { "type": "integer", "format": "int64" }, "status": { "type": "string", "nullable": true }, "roomStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatMessageItemQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessageItem" }, "nullable": true } }, "additionalProperties": false }, "ChatModeModel": { "type": "object", "properties": { "status": { "type": "integer", "description": "Durum 1: aktif, 0: pasif", "format": "int32" }, "settings": { "$ref": "#/components/schemas/ChatWidgetModelPublic" }, "triggers": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundMessage" }, "nullable": true }, "chatbots": { "type": "array", "items": { "$ref": "#/components/schemas/PublicChatbotModel" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/PublicChatCustomFieldModel" }, "nullable": true }, "visitor": { "$ref": "#/components/schemas/ChatVisitorDataItem" }, "statusCode": { "$ref": "#/components/schemas/ResultCode" }, "allowedExtensions": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatModeResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/ChatModeModel" } }, "additionalProperties": false }, "ChatRoom": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userRatingId": { "type": "integer", "format": "int64", "nullable": true }, "userRatingScore": { "type": "number", "format": "double", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "companyName": { "type": "string", "nullable": true }, "departmentName": { "type": "string", "nullable": true }, "widgetLanguage": { "type": "string", "nullable": true }, "chatId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "rootId": { "type": "integer", "format": "int64" }, "channel": { "$ref": "#/components/schemas/ChannelType" }, "channelId": { "type": "integer", "format": "int64", "nullable": true }, "channelName": { "type": "string", "nullable": true }, "visitor": { "type": "string", "nullable": true }, "visitorName": { "type": "string", "nullable": true }, "visitorPhoto": { "type": "string", "nullable": true }, "assignedTo": { "type": "integer", "format": "int64" }, "assignedToGroup": { "type": "integer", "format": "int64" }, "assignedAgentType": { "type": "string", "description": "Owner kind for Infoset.Types.Models.Responses.ChatRoom.AssignedTo: \"none\" | \"human\" | \"chatbot\" | \"genai\".\r\n`chat_tables.AGENT_ID` carries no discriminator, so the id alone cannot distinguish a\r\nhuman agent from either bot. Only populated by SELECTs that compute it (see\r\n`ChatOwnerKindSql.AssignedAgentTypeCase`); null elsewhere.", "nullable": true }, "chatBotId": { "type": "integer", "description": "The RiveScript bot bound to the room's widget, or 0. Independent of Infoset.Types.Models.Responses.ChatRoom.AssignedTo\r\non purpose — \"a bot is bound to this room\" and \"a bot owns this room right now\" are different\r\nquestions. Only populated by SELECTs that resolve the widget link.", "format": "int64" }, "contactId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "status": { "type": "string", "nullable": true }, "isResolved": { "type": "integer", "format": "int32" }, "closingTime": { "type": "string", "format": "date-time", "nullable": true }, "lastMessage": { "type": "string", "nullable": true }, "logTime": { "type": "string", "format": "date-time" }, "lastMessageTime": { "type": "string", "format": "date-time" }, "lastMessageIsAgent": { "type": "integer", "format": "int32" }, "chatTagIds": { "type": "string", "nullable": true }, "mentionedUserIds": { "type": "string", "nullable": true }, "firstAssignTimeSec": { "type": "integer", "format": "int64", "nullable": true }, "pageUrl": { "type": "string", "description": "Base URL, e.g. https://abc.com", "nullable": true }, "fullUrl": { "type": "string", "description": "Full URL, e.g. https://abc.com/some/page", "nullable": true }, "referrer": { "type": "string", "description": "Referrer page, e.g. https://yahoo.com if visitor came from Yahoo", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "clientOs": { "type": "string", "nullable": true }, "closedActorType": { "type": "integer", "format": "int32", "nullable": true }, "browserType": { "type": "string", "nullable": true }, "browserVer": { "type": "string", "nullable": true }, "browserLang": { "type": "string", "nullable": true }, "timezoneOffset": { "type": "number", "format": "double" }, "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "utm": { "type": "string", "nullable": true }, "feedBackRate": { "type": "number", "format": "double", "nullable": true }, "feedBackContent": { "type": "string", "nullable": true }, "ticketId": { "type": "integer", "format": "int64" }, "dealId": { "type": "integer", "format": "int64" }, "slaId": { "type": "integer", "format": "int64", "nullable": true }, "widgetId": { "type": "integer", "format": "int64", "nullable": true }, "nextSlaBreach": { "type": "string", "format": "date-time", "nullable": true }, "slaStats": { "$ref": "#/components/schemas/SlaStats" }, "translatedBy": { "type": "string", "nullable": true }, "sessionStartTime": { "type": "string", "format": "date-time", "nullable": true }, "sessionCloseTime": { "type": "string", "format": "date-time", "nullable": true }, "botTransferTime": { "type": "string", "format": "date-time", "nullable": true }, "frTimeSec": { "type": "integer", "format": "int64", "nullable": true, "readOnly": true }, "firstResponseTime": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "resolveTimeSec": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "frTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "resolveTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true }, "resolvedInFirstContact": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "ChatRoomCustomerContext": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "recommendation": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "The persisted customer-context summary/recommendation of a chat room, as served to the\r\ndashboard (initial load of the context panel; live updates arrive separately via the\r\nSignalR push path). Backed by the `chat_customer_context` table." }, "ChatRoomIntent": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "One detected intent of a chat room, as served to the dashboard\r\n(initial load of the header intent badges; live updates arrive separately\r\nvia the `newChatIntent` SignalR event)." }, "ChatRoomQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatRoom" }, "nullable": true } }, "additionalProperties": false }, "ChatRoomSentiment": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "The current sentiment of a chat room, as served to the dashboard\r\n(initial load of the header sentiment badge; live updates arrive separately\r\nvia the SignalR push path)." }, "ChatSentimentDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Sentiment classification result (category + confidence) carried by\r\nInfoset.Types.Models.InternalApi.ChatSentimentRequestDto. Confidence is an integer 0–100." }, "ChatSentimentRequestDto": { "type": "object", "properties": { "correlationId": { "type": "string", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "messageId": { "type": "string", "nullable": true }, "sentiment": { "$ref": "#/components/schemas/ChatSentimentDto" }, "detectedAt": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Wire envelope for the future `POST /api/sentiment/detected` internal endpoint.\r\nMirrors the Kafka `ChatSentimentEvent` contract (zod\r\n`ChatSentimentEventSchema` in the infoset-ai-intent repo); JSON is camelCase." }, "ChatStatusLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64" }, "userState": { "type": "integer", "description": "Agent Durumu 0:sohbeti terketti, 1:sohbete başladı , 2:sohbeti transfer etti", "format": "int32" }, "logTime": { "type": "string", "format": "date-time" }, "actorId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "ChatStatusLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatStatusLog" }, "nullable": true } }, "additionalProperties": false }, "ChatTag": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentIds": { "maxLength": 512, "type": "string", "description": "IDT-1364: comma-separated department (brand) id list — a tag can belong to multiple brands.", "nullable": true }, "rootId": { "type": "integer", "format": "int64" }, "systemTag": { "type": "integer", "format": "int32" }, "name": { "maxLength": 60, "minLength": 1, "type": "string" }, "displayName": { "maxLength": 100, "type": "string", "nullable": true }, "notes": { "maxLength": 1000, "type": "string", "nullable": true }, "assignedUserIds": { "maxLength": 1000, "type": "string", "description": "Assigned user id list [..,n]", "nullable": true } }, "additionalProperties": false }, "ChatTagMessageConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "chatTagId": { "type": "integer", "format": "int64" }, "words": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "ChatTransferModel": { "type": "object", "properties": { "roomId": { "type": "integer", "format": "int64" }, "transferredUserId": { "type": "integer", "format": "int64" }, "transferredGroupId": { "type": "integer", "format": "int64" }, "markAsSolved": { "type": "boolean" } }, "additionalProperties": false }, "ChatTranslateModel": { "type": "object", "properties": { "accountId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "targetLang": { "type": "string", "nullable": true }, "translationEnabled": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ChatValidationModel": { "type": "object", "properties": { "apiKey": { "type": "string", "nullable": true }, "visitorId": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "otpCode": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatVisitorDataItem": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "photoUrl": { "type": "string", "nullable": true }, "userHash": { "type": "string", "description": "visitorId+chat widget private key sha256", "nullable": true }, "createdAt": { "type": "string", "description": "yyyy-MM-dd HH:mm:ss, UTC time", "nullable": true }, "customFields": { "type": "string", "nullable": true }, "company": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatWidgetModel": { "required": [ "domain", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 32, "minLength": 1, "type": "string" }, "domain": { "maxLength": 120, "minLength": 1, "type": "string" }, "workingHourType": { "type": "integer", "format": "int32" }, "offlineMsg": { "maxLength": 1000, "type": "string", "nullable": true }, "onlineMsg": { "maxLength": 1000, "type": "string", "nullable": true }, "chatTitle": { "maxLength": 60, "type": "string", "nullable": true }, "chatSubtitle": { "maxLength": 120, "type": "string", "nullable": true }, "chatTitleOffline": { "maxLength": 60, "type": "string", "nullable": true }, "chatSubtitleOffline": { "maxLength": 120, "type": "string", "nullable": true }, "botLogo": { "maxLength": 1000, "type": "string", "nullable": true }, "language": { "maxLength": 3, "type": "string", "nullable": true }, "status": { "type": "boolean" }, "contactInfo": { "type": "string", "nullable": true }, "messages": { "type": "string", "nullable": true }, "showEmojiButton": { "type": "boolean", "default": true }, "allowVisitorCloseChat": { "type": "boolean", "default": false }, "showAttachmentButton": { "type": "boolean", "default": true }, "showChatHistory": { "type": "boolean", "default": true }, "otpEnabled": { "type": "boolean", "default": false }, "otpEmailRawHtml": { "type": "boolean", "default": false }, "mailId": { "type": "integer", "format": "int64" }, "removeBranding": { "type": "boolean" }, "apiKey": { "type": "string", "nullable": true }, "identityVerification": { "type": "boolean" }, "privateKey": { "type": "string", "nullable": true }, "primaryColor": { "type": "string", "nullable": true }, "contactInfoEnabled": { "type": "boolean" }, "androidKey": { "type": "string", "nullable": true }, "iosKey": { "type": "string", "nullable": true }, "integrations": { "type": "string", "nullable": true }, "chatHomePage": { "$ref": "#/components/schemas/ChatHomePage" }, "desk": { "$ref": "#/components/schemas/ChatDesk" }, "survey": { "$ref": "#/components/schemas/Survey" } }, "additionalProperties": false }, "ChatWidgetModelPublic": { "required": [ "domain", "name" ], "type": "object", "properties": { "privateKey": { "type": "string", "nullable": true, "readOnly": true }, "apiKey": { "type": "string", "nullable": true, "readOnly": true }, "iosKey": { "type": "string", "nullable": true, "readOnly": true }, "androidKey": { "type": "string", "nullable": true, "readOnly": true }, "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 32, "minLength": 1, "type": "string" }, "domain": { "maxLength": 120, "minLength": 1, "type": "string" }, "workingHourType": { "type": "integer", "format": "int32" }, "offlineMsg": { "maxLength": 1000, "type": "string", "nullable": true }, "onlineMsg": { "maxLength": 1000, "type": "string", "nullable": true }, "chatTitle": { "maxLength": 60, "type": "string", "nullable": true }, "chatSubtitle": { "maxLength": 120, "type": "string", "nullable": true }, "chatTitleOffline": { "maxLength": 60, "type": "string", "nullable": true }, "chatSubtitleOffline": { "maxLength": 120, "type": "string", "nullable": true }, "botLogo": { "maxLength": 1000, "type": "string", "nullable": true }, "language": { "maxLength": 3, "type": "string", "nullable": true }, "status": { "type": "boolean" }, "contactInfo": { "type": "string", "nullable": true }, "messages": { "type": "string", "nullable": true }, "showEmojiButton": { "type": "boolean", "default": true }, "allowVisitorCloseChat": { "type": "boolean", "default": false }, "showAttachmentButton": { "type": "boolean", "default": true }, "showChatHistory": { "type": "boolean", "default": true }, "otpEnabled": { "type": "boolean", "default": false }, "otpEmailRawHtml": { "type": "boolean", "default": false }, "mailId": { "type": "integer", "format": "int64" }, "removeBranding": { "type": "boolean" }, "identityVerification": { "type": "boolean" }, "primaryColor": { "type": "string", "nullable": true }, "contactInfoEnabled": { "type": "boolean" }, "integrations": { "type": "string", "nullable": true }, "chatHomePage": { "$ref": "#/components/schemas/ChatHomePage" }, "desk": { "$ref": "#/components/schemas/ChatDesk" }, "survey": { "$ref": "#/components/schemas/Survey" } }, "additionalProperties": false }, "ChatWidgetResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "domain": { "type": "string", "nullable": true }, "workingHourType": { "type": "integer", "format": "int32" }, "offlineMsg": { "type": "string", "nullable": true }, "onlineMsg": { "type": "string", "nullable": true }, "chatTitle": { "type": "string", "nullable": true }, "chatSubtitle": { "type": "string", "nullable": true }, "chatTitleOffline": { "type": "string", "nullable": true }, "chatSubtitleOffline": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "apiKey": { "type": "string", "nullable": true }, "androidKey": { "type": "string", "nullable": true }, "iosKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatWidgetResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatWidgetResponseModel" }, "nullable": true } }, "additionalProperties": false }, "Chatbot": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "avatar": { "type": "string", "nullable": true }, "firstMessage": { "type": "string", "nullable": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotLink" }, "nullable": true }, "topics": { "type": "string", "description": "json object", "nullable": true }, "objectIds": { "type": "string", "nullable": true }, "seen": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ChatbotStatus" }, "publishedVersionId": { "type": "integer", "format": "int64", "readOnly": true }, "channelCount": { "type": "integer", "format": "int32", "readOnly": true }, "workingHourType": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "autoCloseConfig": { "type": "string", "description": "Auto-close configuration as JSON string", "nullable": true }, "parsedConfig": { "$ref": "#/components/schemas/AutoCloseConfigModel" } }, "additionalProperties": false }, "ChatbotConfigurationRequest": { "type": "object", "properties": { "chatbot": { "nullable": true }, "workingHours": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" }, "description": "null leaves current rows unchanged; an empty list clears them.", "nullable": true } }, "additionalProperties": false }, "ChatbotConnectionAuthType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ChatbotConnectionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "departmentId": { "type": "integer", "format": "int64" }, "authType": { "$ref": "#/components/schemas/ChatbotConnectionAuthType" }, "headerName": { "maxLength": 100, "type": "string", "nullable": true }, "secret": { "maxLength": 2000, "type": "string", "nullable": true }, "baseUrl": { "maxLength": 500, "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatbotConnectionResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "authType": { "$ref": "#/components/schemas/ChatbotConnectionAuthType" }, "headerName": { "type": "string", "nullable": true }, "baseUrl": { "type": "string", "nullable": true }, "secretMask": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ChatbotConnectionTestRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ChatbotConnectionTestResponse": { "type": "object", "properties": { "ok": { "type": "boolean" }, "status": { "type": "integer", "format": "int32", "nullable": true }, "reason": { "type": "string", "nullable": true }, "durationMs": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ChatbotLink": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "chatbotId": { "type": "integer", "format": "int64" }, "linkedTableType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "description": "Widget id ya da Integration id.", "format": "int64" }, "linkedSubId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "ChatbotObject": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "language": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChatbotObjectQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotObject" }, "nullable": true } }, "additionalProperties": false }, "ChatbotPreviewModel": { "type": "object", "properties": { "bot": { "$ref": "#/components/schemas/Chatbot" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotObject" }, "nullable": true } }, "additionalProperties": false }, "ChatbotPublishBlocker": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "args": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "category": { "type": "string", "nullable": true, "readOnly": true }, "sortOrder": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "ChatbotPublishCheckModel": { "type": "object", "properties": { "canPublish": { "type": "boolean", "readOnly": true }, "blockers": { "type": "array", "items": { "$ref": "#/components/schemas/ChatbotPublishBlocker" }, "nullable": true } }, "additionalProperties": false }, "ChatbotQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Chatbot" }, "nullable": true } }, "additionalProperties": false }, "ChatbotStatus": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ChatbotVersion": { "required": [ "configSnapshot" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "chatbotId": { "type": "integer", "format": "int64" }, "version": { "type": "integer", "format": "int32" }, "configSnapshot": { "minLength": 1, "type": "string" }, "createdByUserId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CloneProfileRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CollectionArticle": { "required": [ "article", "section" ], "type": "object", "properties": { "article": { "type": "integer", "description": "Article ID", "format": "int64" }, "order": { "type": "integer", "description": "Order of the article in the section, if not given creation date will be used", "format": "int64", "nullable": true }, "section": { "type": "integer", "description": "Section index of the article, default is 0 which is the main section with no label, e.g. \"1\" means putting the\r\narticle under the section with the label \"collection.sections[0]\"", "format": "int64" }, "title": { "type": "string", "nullable": true }, "spoiler": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Company": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "example": "Acme Inc" }, "code": { "maxLength": 200, "type": "string", "default": null, "nullable": true }, "email": { "maxLength": 100, "type": "string", "nullable": true, "example": "info@acmeinc.com" }, "phone": { "maxLength": 20, "type": "string", "description": "Phone number of the company, with country code, without leading + (plus) sign", "nullable": true, "example": "12124567890" }, "web": { "maxLength": 200, "type": "string", "description": "Website domain of the company", "nullable": true, "example": "acmeinc.com" }, "countryCode": { "maxLength": 3, "type": "string", "description": "ISO Alpha-2 country code, see https://www.iban.com/country-codes", "nullable": true, "example": "US" }, "state": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "city": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "town": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "zip": { "maxLength": 10, "type": "string", "default": "", "nullable": true }, "address": { "maxLength": 200, "type": "string", "default": "", "nullable": true }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "photoUrl": { "maxLength": 512, "type": "string", "description": "Company logo URL", "default": null, "nullable": true } }, "additionalProperties": false }, "CompanyInsertBulkResponseWithData": { "type": "object", "properties": { "upsertedData": { "type": "array", "items": { "$ref": "#/components/schemas/Company" }, "description": "Returned only if \"returnFullData\" query parameter is set to true", "nullable": true }, "inserted": { "type": "integer", "format": "int64" }, "updated": { "type": "integer", "format": "int64" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/InsertBulkError" }, "nullable": true } }, "additionalProperties": false }, "CompanyMergeRequestModel": { "required": [ "ids", "newCompany" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "newCompany": { } }, "additionalProperties": false }, "CompanyResponseModel": { "required": [ "name" ], "type": "object", "properties": { "contactCount": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 200, "minLength": 1, "type": "string", "example": "Acme Inc" }, "code": { "maxLength": 200, "type": "string", "default": null, "nullable": true }, "email": { "maxLength": 100, "type": "string", "nullable": true, "example": "info@acmeinc.com" }, "phone": { "maxLength": 20, "type": "string", "description": "Phone number of the company, with country code, without leading + (plus) sign", "nullable": true, "example": "12124567890" }, "web": { "maxLength": 200, "type": "string", "description": "Website domain of the company", "nullable": true, "example": "acmeinc.com" }, "countryCode": { "maxLength": 3, "type": "string", "description": "ISO Alpha-2 country code, see https://www.iban.com/country-codes", "nullable": true, "example": "US" }, "state": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "city": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "town": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "zip": { "maxLength": 10, "type": "string", "default": "", "nullable": true }, "address": { "maxLength": 200, "type": "string", "default": "", "nullable": true }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "photoUrl": { "maxLength": 512, "type": "string", "description": "Company logo URL", "default": null, "nullable": true } }, "additionalProperties": false }, "CompanyResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResponseModel" }, "nullable": true } }, "additionalProperties": false }, "Contact": { "required": [ "firstName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "format": "int64" }, "firstName": { "maxLength": 100, "minLength": 1, "type": "string", "example": "John" }, "lastName": { "maxLength": 100, "type": "string", "nullable": true, "example": "Doe" }, "fullName": { "maxLength": 130, "type": "string", "nullable": true, "readOnly": true, "example": "John Doe" }, "email": { "maxLength": 100, "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 20, "type": "string", "description": "Phone number of the contact, with country code, without leading + (plus) sign", "nullable": true, "example": "12124567890" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "companyName": { "type": "string", "nullable": true, "readOnly": true }, "groupIds": { "maxLength": 1000, "type": "string", "description": "Contact group ids separated by commas", "nullable": true }, "countryCode": { "maxLength": 3, "type": "string", "description": "ISO Alpha-2 country code, see https://www.iban.com/country-codes", "nullable": true, "example": "US" }, "state": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "city": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "town": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "zip": { "maxLength": 10, "type": "string", "default": "", "nullable": true }, "address": { "maxLength": 200, "type": "string", "default": "", "nullable": true }, "status": { "maxLength": 1, "type": "string", "description": "

Enum values:

", "default": "L", "nullable": true }, "department": { "maxLength": 100, "type": "string", "nullable": true, "example": "Product" }, "job": { "maxLength": 100, "type": "string", "nullable": true, "example": "Software Engineer" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "color": { "maxLength": 20, "type": "string", "description": "Contact's background color, only used if there's no PhotoUrl", "nullable": true, "example": "#4c65ff" }, "photoUrl": { "maxLength": 512, "type": "string", "description": "Contact's photo URL", "nullable": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "blocked": { "type": "integer", "description": "Whether the contact is blocked.\r\nIf true; emails, chats, calls etc. from this contact will be ignored.", "format": "int32", "nullable": true }, "visitor": { "maxLength": 200, "type": "string", "description": "Contact's unique identifier for chat conversations", "default": null, "nullable": true }, "isEmailAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isCallAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isSmsAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isWaMarketingAllowed": { "type": "integer", "description": "Read-only provider consent state; it is surfaced on the contact model for filtering but is\r\ndeliberately excluded from contact editing.", "format": "int32", "nullable": true }, "waUserId": { "type": "string", "description": "Allows identity lookup to continue when Meta no longer exposes the phone number.", "nullable": true }, "waUsername": { "type": "string", "description": "Provides a display fallback without replacing the contact's user-managed name.", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastContacted": { "type": "string", "format": "date-time", "nullable": true }, "lastHeard": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ContactGroup": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "notes": { "maxLength": 10000, "type": "string", "nullable": true }, "createdUserId": { "type": "integer", "format": "int64" }, "updatedUserId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ContactGroupResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "contactCount": { "type": "integer", "format": "int32" }, "openDeals": { "type": "integer", "format": "int32" }, "wonDeals": { "type": "integer", "format": "int32" }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ContactGroupResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroupResponseModel" }, "nullable": true } }, "additionalProperties": false }, "ContactInfoDto": { "type": "object", "properties": { "contactId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Contact info response for `GET /api/contacts/{contactId}`.\r\nAll identifying fields (`Name`, `Email`, `Phone`) are nullable." }, "ContactInsertBulkResponseWithData": { "type": "object", "properties": { "upsertedData": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" }, "description": "Returned only if \"returnFullData\" query parameter is set to true", "nullable": true }, "inserted": { "type": "integer", "format": "int64" }, "updated": { "type": "integer", "format": "int64" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/InsertBulkError" }, "nullable": true } }, "additionalProperties": false }, "ContactMergeRequestModel": { "required": [ "ids", "newContact" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "newContact": { } }, "additionalProperties": false }, "ContactResponseModel": { "required": [ "firstName" ], "type": "object", "properties": { "country": { "type": "string", "nullable": true }, "openDeals": { "type": "integer", "format": "int32" }, "wonDeals": { "type": "integer", "format": "int32" }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "format": "int64" }, "firstName": { "maxLength": 100, "minLength": 1, "type": "string", "example": "John" }, "lastName": { "maxLength": 100, "type": "string", "nullable": true, "example": "Doe" }, "fullName": { "maxLength": 130, "type": "string", "nullable": true, "readOnly": true, "example": "John Doe" }, "email": { "maxLength": 100, "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 20, "type": "string", "description": "Phone number of the contact, with country code, without leading + (plus) sign", "nullable": true, "example": "12124567890" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "companyName": { "type": "string", "nullable": true, "readOnly": true }, "groupIds": { "maxLength": 1000, "type": "string", "description": "Contact group ids separated by commas", "nullable": true }, "countryCode": { "maxLength": 3, "type": "string", "description": "ISO Alpha-2 country code, see https://www.iban.com/country-codes", "nullable": true, "example": "US" }, "state": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "city": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "town": { "maxLength": 100, "type": "string", "default": "", "nullable": true }, "zip": { "maxLength": 10, "type": "string", "default": "", "nullable": true }, "address": { "maxLength": 200, "type": "string", "default": "", "nullable": true }, "status": { "maxLength": 1, "type": "string", "description": "

Enum values:

", "default": "L", "nullable": true }, "department": { "maxLength": 100, "type": "string", "nullable": true, "example": "Product" }, "job": { "maxLength": 100, "type": "string", "nullable": true, "example": "Software Engineer" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "color": { "maxLength": 20, "type": "string", "description": "Contact's background color, only used if there's no PhotoUrl", "nullable": true, "example": "#4c65ff" }, "photoUrl": { "maxLength": 512, "type": "string", "description": "Contact's photo URL", "nullable": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "blocked": { "type": "integer", "description": "Whether the contact is blocked.\r\nIf true; emails, chats, calls etc. from this contact will be ignored.", "format": "int32", "nullable": true }, "visitor": { "maxLength": 200, "type": "string", "description": "Contact's unique identifier for chat conversations", "default": null, "nullable": true }, "isEmailAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isCallAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isSmsAllowed": { "type": "integer", "format": "int32", "nullable": true }, "isWaMarketingAllowed": { "type": "integer", "description": "Read-only provider consent state; it is surfaced on the contact model for filtering but is\r\ndeliberately excluded from contact editing.", "format": "int32", "nullable": true }, "waUserId": { "type": "string", "description": "Allows identity lookup to continue when Meta no longer exposes the phone number.", "nullable": true }, "waUsername": { "type": "string", "description": "Provides a display fallback without replacing the contact's user-managed name.", "nullable": true }, "lastSeen": { "type": "string", "format": "date-time", "nullable": true }, "lastContacted": { "type": "string", "format": "date-time", "nullable": true }, "lastHeard": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ContactResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContactResponseModel" }, "nullable": true } }, "additionalProperties": false }, "ConversationMessageDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "senderType": { "type": "string", "nullable": true }, "senderName": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One message in a conversation thread, in the wire format consumed by the\r\nAI-side `ConversationMessageSchema`." }, "ConversationThreadDto": { "type": "object", "properties": { "roomId": { "type": "integer", "format": "int64" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationMessageDto" }, "nullable": true } }, "additionalProperties": false, "description": "Conversation thread response for `GET /api/chat/rooms/{roomId}/thread`.\r\nMessages are ordered oldest-first." }, "CopilotConfigDto": { "type": "object", "properties": { "accountId": { "type": "integer", "format": "int64" }, "enabled": { "type": "boolean" }, "modelTemperature": { "type": "number", "format": "double" }, "maxResponseTokens": { "type": "integer", "format": "int32" }, "customSystemPrompt": { "type": "string", "nullable": true }, "departmentId": { "type": "integer", "format": "int64" }, "selectedDeskIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Read-side DTO for the AI Copilot tenant configuration (IDT-788).\r\nReturned by both the admin UI endpoint (`/v1/admin/copilot/config`) and the\r\ninternal sidecar endpoint (`/api/copilot/config`). If no row exists for the\r\ntenant, the service returns this DTO populated with platform defaults rather than\r\ninserting a row eagerly — the row is created on first PUT.\r\n \r\nMulti-department (brand) support: config is keyed by (AccountId, DepartmentId).\r\nInfoset.Types.Models.Admin.CopilotConfigDto.DepartmentId = 0 is the account-level default row; department-scoped\r\nrows carry the actual brand id. A department read with no row falls back to the\r\naccount-level (dept 0) row as a whole, and the returned Infoset.Types.Models.Admin.CopilotConfigDto.DepartmentId\r\nreflects the ACTUAL row served (0 after a fallback), not the requested department.\r\n \r\nInfoset.Types.Models.Admin.CopilotConfigDto.SelectedDeskIds is the set of help-center desk ids this config applies\r\nto. The distinction between null and empty is meaningful and preserved end-to-end:\r\n`null` — DB column is NULL — \"all desks\" (no restriction).empty array — DB column is the empty string — \"no desks\".non-empty — DB column is a comma-separated list of desk ids." }, "CopilotSuggestionArticle": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "articleId": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "deskId": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A help-center article cited as a suggestion source. Only Infoset.Service.InternalApi.CopilotSuggestionArticle.Title is\r\nguaranteed; the rest are best-effort link/date fields, absent for KB\r\nfiles uploaded before those attributes existed." }, "CopilotSuggestionItem": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "sources": { "$ref": "#/components/schemas/CopilotSuggestionSources" }, "suggestionId": { "type": "integer", "description": "AI-side row id an agent's feedback attaches to; null when ungradable.", "format": "int64", "nullable": true }, "feedback": { "type": "string", "description": "The REQUESTING agent's own vote; see Infoset.Service.InternalApi.RoomLastSuggestionDto.Feedback.", "nullable": true } }, "additionalProperties": false, "description": "One copilot suggestion within a Infoset.Service.InternalApi.RoomSuggestionsDto." }, "CopilotSuggestionSources": { "type": "object", "properties": { "articles": { "type": "array", "items": { "$ref": "#/components/schemas/CopilotSuggestionArticle" }, "nullable": true }, "pastConversationUsed": { "type": "boolean" }, "pastSuggestionUsed": { "type": "boolean" }, "contactInfoUsed": { "type": "boolean" } }, "additionalProperties": false, "description": "Provenance flags / sources backing a single suggestion." }, "CopyGroupRequestModel": { "required": [ "groupIds", "ids" ], "type": "object", "properties": { "ids": { "maxLength": 100000, "minLength": 1, "type": "string", "description": "Comma-separated contact ids" }, "groupIds": { "maxLength": 100000, "minLength": 1, "type": "string", "description": "Comma-separated target group ids" } }, "additionalProperties": false }, "CountryResponseModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CountryResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CountryResponseModel" }, "nullable": true } }, "additionalProperties": false }, "CustomDashboard": { "required": [ "departmentIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/CustomDashboardVisibility" }, "visibleTo": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "layout": { "type": "string", "description": "An array of objects, e.g. [{ i: \"key1\", x: 0, y: 0, w: 1, h: 2 }, ...]", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "customReports": { "type": "array", "items": { "$ref": "#/components/schemas/CustomReport" }, "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CustomDashboardQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomDashboard" }, "nullable": true } }, "additionalProperties": false }, "CustomDashboardVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CustomField": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fieldName": { "type": "string", "nullable": true }, "fieldType": { "$ref": "#/components/schemas/CustomFieldType" }, "fieldOptions": { "type": "string", "nullable": true }, "orderNo": { "type": "integer", "format": "int32" }, "linkedTable": { "$ref": "#/components/schemas/Table" }, "fieldProperties": { "type": "string", "nullable": true }, "systemField": { "type": "boolean" }, "departmentIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomFieldQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" }, "nullable": true } }, "additionalProperties": false }, "CustomFieldType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "CustomNotificationCreateModel": { "required": [ "body", "title", "userId" ], "type": "object", "properties": { "userId": { "type": "integer", "description": "ID of the user to be notified", "format": "int64" }, "title": { "minLength": 1, "type": "string", "description": "Notification title" }, "body": { "minLength": 1, "type": "string", "description": "Notification body" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "CustomReport": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "jsonQuery": { "type": "string", "nullable": true }, "settings": { "$ref": "#/components/schemas/CustomReportSettings" }, "lastNotificationTime": { "type": "string", "format": "date-time", "nullable": true }, "customDashboardId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CustomReportNotificationSettings": { "type": "object", "properties": { "frequency": { "type": "string", "description": "One of \"hourly\", \"daily\", \"weekly\", \"monthly\"", "nullable": true }, "day": { "type": "integer", "description": "For weekly, 0 = Monday, 6 = Sunday.\r\nFor monthly, 1 = 1st of the month, 31 = 31st of the month", "format": "int32" }, "time": { "type": "string", "nullable": true }, "emailRecipients": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomReportResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/CustomReport" } }, "additionalProperties": false }, "CustomReportSettings": { "type": "object", "properties": { "notification": { "$ref": "#/components/schemas/CustomReportNotificationSettings" } }, "additionalProperties": false }, "CustomerActivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "string", "nullable": true }, "data": { "nullable": true }, "timestamp": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CustomerActivityQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerActivity" }, "nullable": true } }, "additionalProperties": false }, "CustomerContextAggregateDto": { "type": "object", "properties": { "hasContact": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int64" }, "roomId": { "type": "integer", "format": "int64" }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "profile": { "$ref": "#/components/schemas/ProfileDto" }, "openTicketCount": { "type": "integer", "format": "int32" }, "openTickets": { "type": "array", "items": { "$ref": "#/components/schemas/OpenTicketDto" }, "nullable": true }, "lastTicket": { "$ref": "#/components/schemas/TicketBriefDto" }, "longOpenTicket": { "$ref": "#/components/schemas/LongOpenTicketDto" }, "intentHistory": { "type": "array", "items": { "$ref": "#/components/schemas/IntentFreqDto" }, "nullable": true }, "tone": { "$ref": "#/components/schemas/ToneDto" } }, "additionalProperties": false, "description": "Aggregated customer-context response assembled by the Infoset API for the\r\nAI customer-context service. JSON is camelCase, consumed by the AI-side schema." }, "CustomerContextPayloadDto": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "recommendation": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Generated customer context (summary + recommendation) carried by\r\nInfoset.Types.Models.InternalApi.ChatCustomerContextRequestDto." }, "Dashboard": { "required": [ "departmentIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "layout": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "visibility": { "$ref": "#/components/schemas/DashboardVisibility" }, "visibleTo": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "dashboardWidgets": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" }, "nullable": true } }, "additionalProperties": false }, "DashboardQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" }, "nullable": true } }, "additionalProperties": false }, "DashboardVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "DashboardWidget": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "jsonQuery": { "type": "string", "nullable": true }, "dashboardId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DashboardWidgetQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardWidget" }, "nullable": true } }, "additionalProperties": false }, "DashboardWidgetResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/DashboardWidget" } }, "additionalProperties": false }, "DataFieldFilter": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/QueryPrefix" }, "val": { "nullable": true } }, "additionalProperties": false }, "DataSourceType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "Deal": { "required": [ "name", "orderNo", "pipelineId", "source", "stageId", "status" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "name": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Name of the deal", "example": "Example deal" }, "contactId": { "type": "integer", "description": "ID of the related contact", "format": "int64" }, "companyId": { "type": "integer", "description": "ID of the related company", "format": "int64", "nullable": true }, "pipelineId": { "type": "integer", "description": "ID of the pipeline that this deal belongs to", "format": "int64" }, "stageId": { "type": "integer", "description": "ID of the stage that this deal belongs to", "format": "int64" }, "departmentId": { "type": "integer", "description": "Department (brand) this deal belongs to. Derived from the pipeline on create (IDT-416).", "format": "int64" }, "orderNo": { "type": "integer", "description": "Kanban stage order", "format": "int32", "example": 0 }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "createdContactId": { "type": "integer", "format": "int64", "writeOnly": true }, "createdAutomationId": { "type": "integer", "format": "int64", "writeOnly": true }, "ownerUserId": { "type": "integer", "description": "ID of the assigned user", "format": "int64" }, "ownerGroupId": { "type": "integer", "description": "ID of the assigned group", "format": "int64", "nullable": true }, "followerIds": { "maxLength": 128, "type": "string", "description": "IDs of the users following this deal, separated by commas", "default": null, "nullable": true }, "expectedCloseDate": { "type": "string", "description": "Expected close date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true }, "closingDate": { "type": "string", "description": "Closing date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true }, "value": { "type": "number", "description": "Deal value", "format": "double" }, "currency": { "maxLength": 3, "type": "string", "description": "Deal currency in ISO 4217 format, defaults to user's or account's currency", "nullable": true, "example": "USD" }, "notes": { "maxLength": 10000, "type": "string", "description": "Deal's description", "default": "", "nullable": true }, "lostReason": { "maxLength": 128, "type": "string", "description": "Null if the deal is not lost, otherwise the cause of losing this deal", "default": null, "nullable": true }, "source": { "type": "integer", "format": "int32", "default": 11 }, "status": { "$ref": "#/components/schemas/DealStatus" }, "lastStatusChangeDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "description": "Linked item ID", "format": "int64", "writeOnly": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "categoryIds": { "maxLength": 128, "type": "string", "nullable": true }, "isSpam": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "DealLog": { "required": [ "dealId", "status" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "dealId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/DealStatus" }, "pipelineId": { "type": "integer", "format": "int64" }, "stageId": { "type": "integer", "format": "int64" }, "notes": { "type": "string", "nullable": true }, "isPrivate": { "type": "integer", "description": "Whether it's a private note (visible to team members) or public note (visible to both contact and team members)", "format": "int32" }, "callLogId": { "type": "integer", "format": "int64", "nullable": true }, "chatId": { "type": "integer", "format": "int64", "nullable": true }, "emailId": { "type": "integer", "format": "int64", "nullable": true }, "smsLogId": { "type": "integer", "format": "int64", "nullable": true }, "contactId": { "type": "integer", "description": "ID of the contact that created this log", "format": "int64", "nullable": true }, "automationId": { "type": "integer", "description": "ID of the automation that created this log", "format": "int64", "nullable": true }, "pinDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "$ref": "#/components/schemas/DealTicketLogMetadata" } }, "additionalProperties": false }, "DealLogResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "dealId": { "type": "integer", "format": "int64" }, "pipelineId": { "type": "integer", "format": "int64" }, "stageId": { "type": "integer", "format": "int64" }, "createdUserId": { "type": "integer", "format": "int64" }, "createdContactId": { "type": "integer", "format": "int64" }, "createdAutomationId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/UserReactionResponseModel" }, "nullable": true }, "isPrivate": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/DealStatus" }, "callLogId": { "type": "integer", "format": "int64" }, "chatRoomId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64" }, "emailId": { "type": "integer", "format": "int64" }, "smsLogId": { "type": "integer", "format": "int64" }, "emailFileNames": { "type": "string", "nullable": true }, "emailFileLinks": { "type": "string", "nullable": true }, "emailFileSizes": { "type": "string", "nullable": true }, "pinDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "$ref": "#/components/schemas/DealTicketLogMetadata" } }, "additionalProperties": false }, "DealLogResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DealLogResponseModel" }, "nullable": true } }, "additionalProperties": false }, "DealMergeRequestModel": { "required": [ "ids", "newDeal" ], "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "newDeal": { } }, "additionalProperties": false }, "DealResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhone": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "categoryIds": { "type": "string", "nullable": true }, "contactJobTitle": { "type": "string", "nullable": true }, "categoryNames": { "type": "string", "nullable": true }, "pipelineId": { "type": "integer", "format": "int64", "nullable": true }, "stageId": { "type": "integer", "format": "int64", "nullable": true }, "departmentId": { "type": "integer", "format": "int64", "nullable": true }, "orderNo": { "type": "integer", "format": "int32", "nullable": true }, "createdUserId": { "type": "integer", "format": "int64", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedUserId": { "type": "integer", "format": "int64", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "ownerUserId": { "type": "integer", "format": "int64", "nullable": true }, "ownerGroupId": { "type": "integer", "format": "int64", "nullable": true }, "ownerName": { "type": "string", "nullable": true }, "ownerPhoto": { "type": "string", "nullable": true }, "ownerColor": { "type": "string", "nullable": true }, "followerIds": { "type": "string", "nullable": true }, "expectedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "lostReason": { "type": "string", "nullable": true }, "source": { "type": "integer", "format": "int32", "nullable": true }, "status": { "$ref": "#/components/schemas/DealStatus" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true }, "customFields": { "type": "string", "nullable": true }, "isSpam": { "type": "integer", "format": "int32", "nullable": true }, "highlights": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "DealResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DealResponseModel" }, "nullable": true } }, "additionalProperties": false }, "DealStatus": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "DealTicketLogMetadata": { "type": "object", "properties": { "event": { "type": "string", "nullable": true }, "previousValue": { "maxLength": 200, "type": "string", "nullable": true }, "value": { "maxLength": 200, "type": "string", "nullable": true }, "extra": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "Department": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DepartmentStatus" }, "isDefault": { "type": "boolean" }, "timezoneId": { "type": "integer", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "deletedAt": { "type": "string", "format": "date-time", "nullable": true }, "deleteTargetDepartmentId": { "type": "integer", "format": "int64", "nullable": true }, "channelSnapshot": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DepartmentAccessScopeResponse": { "type": "object", "properties": { "kind": { "type": "string", "nullable": true, "readOnly": true }, "departmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DepartmentPageSelection": { "type": "object", "additionalProperties": false, "description": "Selects departments for a page-level query. The query-string value can be `all`\r\nor a comma-separated list of positive department IDs, such as `12,34`." }, "DepartmentStatus": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "Desk": { "required": [ "color", "defaultLanguage", "slug" ], "type": "object", "properties": { "_id": { "type": "string", "nullable": true }, "_infoset": { "$ref": "#/components/schemas/HelpdeskInfosetData" }, "slug": { "type": "string", "description": "URL slug for your help center, must match [a-zA-Z0-9-]+, i.e. infoset.help/{yourDeskSlug}" }, "domain": { "type": "string", "description": "Custom domain for your help center", "nullable": true }, "homepage": { "type": "string", "description": "Link to your website homepage", "nullable": true }, "defaultLanguage": { "type": "string", "description": "Default language code of your help center, e.g. \"en\" \"fr\" \"tr\"" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskLanguageSettings" }, "nullable": true }, "faviconUrl": { "type": "string", "description": "Favicon URL", "nullable": true }, "logoUrl": { "type": "string", "description": "Logo URL", "nullable": true }, "headerImgUrl": { "type": "string", "description": "Header image URL", "nullable": true }, "socialMediaImgUrl": { "type": "string", "description": "Social media image URL, displayed on the social media share cards", "nullable": true }, "color": { "type": "string", "description": "Theme color of the help center" }, "footerLinks": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskFooterLink" }, "nullable": true }, "socialLinks": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskSocialLink" }, "nullable": true }, "showInfosetLink": { "type": "boolean", "description": "Display the Infoset branding in the footer or not", "nullable": true }, "departmentId": { "type": "integer", "description": "Brand (Infoset department id) this desk belongs to; null for brand-less/legacy desks", "format": "int64", "nullable": true }, "integrations": { "$ref": "#/components/schemas/HelpdeskIntegrations" }, "createdAt": { "description": "Creation date", "nullable": true }, "updatedAt": { "description": "Last update date", "nullable": true }, "visibility": { "$ref": "#/components/schemas/DeskVisibilitySettings" } }, "additionalProperties": false }, "DeskVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "DeskVisibilitySettings": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DeskVisibility" }, "userGroupIds": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "DialPlan": { "required": [ "destinationVirtualNumber", "name", "sourceVirtualNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "Dial Plan Adı" }, "planType": { "$ref": "#/components/schemas/PlanType" }, "sourceVirtualNumber": { "minLength": 1, "type": "string", "description": "Kaynak Sanal Numarası (Gelen Çağrı İçin Gateway Sanal Numarası, Giden Çağrı İçin Tuşlanan Prefix Kodu gibi örneğin\r\n'9' gibi )" }, "destinationVirtualNumber": { "minLength": 1, "type": "string", "description": "Hedef Sanal Numarası (Gelen Çağrı İçin IVR Menü Sanal Numarası, Giden Çağrı İçin Gateway Sanal Numarası gibi )" }, "didMask": { "type": "string", "description": "Varsa Gelen Çağrı İçin Kabul Edilecek DID Numarası", "nullable": true }, "workingHourType": { "type": "integer", "description": "Çalışma Saatleri Seçeneği\r\n0:Yok,\r\n1: Sistem Ayarları Mesai Saati Kullan,\r\n2: Özel Mesai Saati Kullan\r\n3: Mesai saatleri dışı", "format": "int32" }, "sipServerId": { "type": "integer", "format": "int64" }, "sourceVirtualNumber2": { "type": "string", "description": "Comma-wrapped form of Infoset.Types.Models.DialPlan.SourceVirtualNumber (\",X,\") used for substring matching\r\nagainst caller/extension lookups. Populated by the CallServer read SQL via CONCAT — legacy\r\nCS stored this as a derived column on the cached DataTable and matchers depend on the\r\nwrapping commas to avoid false hits (e.g. \"12\" inside \"123\"). Empty when no source mask set.", "nullable": true }, "didMask2": { "type": "string", "description": "Comma-wrapped form of Infoset.Types.Models.DialPlan.DidMask (\",X,\") used for DID matching. Same\r\nsemantics as Infoset.Types.Models.DialPlan.SourceVirtualNumber2.", "nullable": true } }, "additionalProperties": false }, "DialPlanQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DialPlan" }, "nullable": true } }, "additionalProperties": false }, "DialerDtmfLinkModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "dialerId": { "type": "integer", "description": "Bağlı Dialer Id", "format": "int64" }, "dtmf": { "type": "string", "description": "Tuş bilgisi", "nullable": true }, "reportHeader": { "type": "string", "description": "Rapor başlığı", "nullable": true }, "wavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "actionType": { "type": "integer", "description": "Yapılacak İşlem\r\n0: Dahiliye Aktar\r\n1: Dahili Posta Kutusuna Aktar\r\n2: Çağrı Merkezi Grubuna Aktar\r\n3: Çağrı Merkezi Grubu Posta Kutusuna Aktar\r\n4: Numaraya Aktar\r\n5: Başka Menüye Geç\r\n6: Menüyü Tekrar Et\r\n7: Dil Değiştir(Ses Dizini Değiştir)\r\n8: Hattı Kapat", "format": "int32" }, "actionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "notifyDtmfToUrl": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Otomatik Arama DTMF Tuş Tablosu\r\nOtomatik arama işleminden sonra tuş listesi varsa çağrı cevaplandığında önce anons okunur (DialerTable->WAV_FILE-) ve tuşlama işlemine göre çağrı akışı ACTION_TYPE ile devam eder" }, "DialerModeType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "DialerModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "description": "Adı", "nullable": true }, "dialerMode": { "$ref": "#/components/schemas/DialerModeType" }, "dataSourceType": { "$ref": "#/components/schemas/DataSourceType" }, "dataSource": { "type": "string", "description": "Web servis ise endpoint, yada grup Id listesi [..,n]", "nullable": true }, "dataParameters": { "type": "string", "description": "Web servise gönderilecek paramereler, Key=Value,Key=Value,..n parametreler, örneğin kayıt sayısı=10, min. fatura tutarı=100 gibi.", "nullable": true }, "dialerType": { "type": "integer", "description": "Arama Tipi =1 Boşta Agent Olduğunda Ara,=2 Çağrıların Cevaplanma Oranına Göre Ara, =3 Çağrıların Cevaplanma Süresine Göre Ara", "format": "int32" }, "dialerTypeParameter": { "type": "string", "description": "DialerType = 2 veya 3 ise;\r\nÇağrıların Cevaplanma Oranı: Örneğin aramaların ortalama 3 çağrıda bir açılma oranı varsa sistem aynı anda 3 arama başlat\r\nÇağrıların Cevaplanma Süresi: Ortalama konuşma süresi üzerinden 10 snlik bir bekleme sonunda arama başlat", "nullable": true }, "outboundDialerPlanNumber": { "type": "string", "description": "Dış Hat Çıkış İçin kullanılacak Dial Plan numarası", "nullable": true }, "callStartNumber": { "type": "string", "description": "Çağrının transfer edileceği sanal numara-> plugin", "nullable": true }, "callEndNumber": { "type": "string", "description": "Çağrının sonlanma numarası, çağrı merkezi kuyruğu gibi", "nullable": true }, "startTime": { "type": "string", "description": "Başlangıç Zamanı", "format": "date-time", "nullable": true }, "lastProcTime": { "type": "string", "description": "Son işlem zamanı", "format": "date-time", "nullable": true }, "workingHourType": { "type": "integer", "description": "Çalışma Saatleri Seçeneği 0:Yok, 1: Sistem Ayarları Mesai Saati Kullan, 2: Özel Mesai Saati Kullan", "format": "int32" }, "periodType": { "type": "integer", "description": "Çalışma Peryodu Tipi,0:Tek Seferlik,1:Saatlik,2:Haftalık,3:Aylık,4:Yıllık, 5: Yok,...", "format": "int32" }, "periodIndis": { "type": "integer", "description": "PeriodType=1 ise saat aralığı (2 saatte bir gibi), =2 ise 1: Pazar, 2:pazartesi .., PERIOD_TYPE=3 ise ayın 1,2,3'ü gibi...", "format": "int32" }, "maxRepeatCount": { "type": "integer", "description": "0: Sürekli, 0> Max çalışma sayısı, örneğin 5 çalışmadan sonra durdur", "format": "int32" }, "status": { "type": "integer", "description": "Durumu, =0 Pasif, =1 Aktif, =2 Silindi", "format": "int32" }, "callWaitTimeSec": { "type": "integer", "description": "Otomatik Arama Süre Aralığı (sn cinsinden)", "format": "int32" }, "maxRingTimeSec": { "type": "integer", "description": "Arama cevap bekleme süresi (sn cinsinden). Max 60sn olabilir", "format": "int32" }, "autoCallCount": { "type": "integer", "description": "Arama Sonuçlanana Kadar Tekrarlanacak Arama Sayısı, Örneğin en fazla 3 defa dene, ulaşılamazsa tekrar arama yapılmasın. Max 10 olabilir", "format": "int32" }, "maxChannel": { "type": "integer", "description": "Maksimum Kullanılacak Eş Zamanlı Kanal Sayısı", "format": "int32" }, "wavFile": { "type": "string", "description": "WAV_FILE TEXT NULL, /* Varsa cevaplandığında okutulacak wav dosya", "nullable": true }, "sessionCount": { "type": "integer", "description": "Toplam oturum/çalışmma sayısı", "format": "int32" }, "callCount": { "type": "integer", "description": "Toplam arama", "format": "int32" }, "errorCount": { "type": "integer", "description": "Başarısız arama", "format": "int32" }, "busyCount": { "type": "integer", "description": "Meşgul", "format": "int32" }, "wrongNumberCount": { "type": "integer", "description": "Hatalı numara", "format": "int32" }, "successfulCount": { "type": "integer", "description": "Başarılı arama", "format": "int32" }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DialerModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DialerModel" }, "nullable": true } }, "additionalProperties": false }, "DialerSessionLogModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "dialerId": { "type": "integer", "description": "Bağlı Dialer Id", "format": "int64" }, "dialerSessionId": { "type": "integer", "description": "Bağlı Session Id", "format": "int64" }, "phoneNumber": { "type": "string", "description": "Aranacak Telefon numarası", "nullable": true }, "phoneNumber2": { "type": "string", "nullable": true }, "phoneNumber3": { "type": "string", "nullable": true }, "lastCallTime": { "type": "string", "description": "Son Arama Zamanı", "format": "date-time" }, "lastCallDuration": { "type": "integer", "description": "Son arama süresi (ms cinsinden)", "format": "int32" }, "lastCallState": { "type": "integer", "description": "Son Arama Durumu: =0 Tanımsız, =1 Meşgul, =2 Cevap Yok, =3 Numara Hatalı, =4 Arama Başarı ile tamamlandı", "format": "int32" }, "callEndState": { "type": "integer", "description": "Başarılı Arama Sonlanma Durumu: =0 Tanımsız, =1 Çağrı Doğrudan Agenta Aktarıldı, =2 Çağrı Kuyrukta Bekleyip Agenta Aktarıldı, =3 Çağrı Kuyrukta Bekleyip Hattı Kapattı , =4 Aranan Kişi Hattı Kapattı, =5 Sistem Hattı Kapattı, =6 Mesaj Alındı", "format": "int32" }, "callCount": { "type": "integer", "description": "Arama sayısı", "format": "int32" }, "lastCallDtmf": { "type": "string", "description": "Son Aramada Tuşlanan Numaralar", "nullable": true }, "callParameters": { "type": "string", "description": "Key=Value,Key=Value,..n parametreler\r\nÖrnek\r\nFATURA HATIRLATMA TEMPLATE -> {odenmemis.wav} + {FATURA_TOPLAM} + {₺.wav} + borcvar.wav\r\nRANDEVU HATIRLATMA TEMPLATE -> {tarih} + {tarihinde.wav} + {saat} + {randevuvar.wav} gibi...", "nullable": true }, "callerNumber": { "type": "string", "description": "Arayan numara (Dış hat numarası)", "nullable": true }, "voipUserId": { "type": "integer", "description": "", "format": "int64", "nullable": true } }, "additionalProperties": false }, "DialerSessionLogModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DialerSessionLogModel" }, "nullable": true } }, "additionalProperties": false }, "DialerSessionModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "dialerId": { "type": "integer", "description": "Bağlı Dialer Id", "format": "int64" }, "startTime": { "type": "string", "description": "Otomatik Arama başlangıç zamanı", "format": "date-time" }, "lastProcTime": { "type": "string", "description": "Son işlem zamanı", "format": "date-time" }, "status": { "type": "integer", "description": "Durumu\r\n=0 Yok,= 1 İşlem devam ediyor, =2 Durduruldu, =3 İptal edildi, = 4 Arama Görevi Tamamlandı =5 Silindi", "format": "int32" }, "notes": { "type": "string", "description": "", "nullable": true }, "callCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "busyCount": { "type": "integer", "format": "int32" }, "noAnswerCount": { "type": "integer", "format": "int32" }, "wrongNumberCount": { "type": "integer", "format": "int32" }, "successfulCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DialerSessionModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DialerSessionModel" }, "nullable": true } }, "additionalProperties": false }, "EditCallLogTagRequestModel": { "type": "object", "properties": { "tagIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailFile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "emailId": { "type": "integer", "format": "int64" }, "fileName": { "type": "string", "nullable": true }, "fileLink": { "type": "string", "nullable": true }, "fileLength": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EmailFileQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmailFile" }, "nullable": true } }, "additionalProperties": false }, "EmailLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "mailAccountId": { "type": "integer", "format": "int64" }, "messageId": { "type": "string", "description": "email mesaj ID", "nullable": true }, "logType": { "$ref": "#/components/schemas/EmailLogType" }, "isRead": { "type": "integer", "description": "0:okunmadı, 1:okundu", "format": "int32" }, "isSpam": { "type": "integer", "description": "0:hayır, 1:evet", "format": "int32" }, "toAddress": { "type": "string", "nullable": true }, "ccAddress": { "type": "string", "nullable": true }, "bccAddress": { "type": "string", "nullable": true }, "replyToAddress": { "type": "string", "nullable": true }, "fromAddress": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/EmailLogStatus" }, "statusMessage": { "type": "string", "nullable": true }, "userId": { "type": "integer", "description": "Actor user id", "format": "int64" }, "ipAddress": { "type": "string", "description": "Actor's IP address", "nullable": true }, "logTime": { "type": "string", "format": "date-time" }, "msgLength": { "type": "integer", "format": "int32" }, "replyMessageId": { "type": "string", "nullable": true }, "replyReferences": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailLogStatus": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "EmailLogType": { "enum": [ 0, 1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "EmailPriority": { "enum": [ 1, 2, 5, 10, 20, 100 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "EmailQueueModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "mailAccountId": { "type": "integer", "format": "int64" }, "fromAddress": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "toAddress": { "type": "string", "nullable": true }, "ccAddress": { "type": "string", "nullable": true }, "bccAddress": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "priority": { "$ref": "#/components/schemas/EmailPriority" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true }, "replyMessageId": { "type": "string", "description": "Set when this email is reply for a specific email (e.g. when it's a reply to NOT the latest email in a ticket)", "nullable": true }, "replyReferences": { "type": "string", "nullable": true }, "replyLogId": { "type": "integer", "format": "int64", "nullable": true }, "isForward": { "type": "integer", "format": "int32" }, "outboxAppend": { "type": "boolean", "description": "Whether to append this email in sender's outbox or not" }, "attachments": { "type": "array", "items": { "type": "string", "format": "binary" }, "nullable": true } }, "additionalProperties": false }, "ErrorResource": { "type": "object", "properties": { "success": { "type": "boolean", "default": false, "readOnly": true }, "errorCode": { "type": "integer", "description": "See Infoset.Types.ResultCode for all possible error codes", "format": "int32", "default": -1 }, "errorName": { "type": "string", "description": "See Infoset.Types.ResultCode for all possible error names", "nullable": true, "readOnly": true }, "message": { "type": "string", "description": "Error message", "nullable": true }, "details": { "description": "Optional machine-readable context for recoverable business errors.", "default": null, "nullable": true } }, "additionalProperties": false }, "ErrorResourceQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResource" }, "nullable": true } }, "additionalProperties": false }, "Event": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "type": { "type": "string", "nullable": true }, "data": { "nullable": true }, "timestamp": { "type": "string", "format": "date-time" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "EventQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Event" }, "nullable": true } }, "additionalProperties": false }, "Feedback": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "rate": { "type": "number", "format": "double" }, "data": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int64" }, "actorId": { "type": "integer", "format": "int64" }, "actorType": { "$ref": "#/components/schemas/FeedbackActorType" }, "surveyId": { "type": "integer", "format": "int64", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FeedbackActorType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "FeedbackResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "rate": { "type": "number", "format": "double" }, "data": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int64" }, "actorId": { "type": "integer", "format": "int64" }, "actorType": { "$ref": "#/components/schemas/FeedbackActorType" }, "surveyId": { "type": "integer", "format": "int64", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "FeedbackResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackResponseModel" }, "nullable": true } }, "additionalProperties": false }, "FileResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "fileName": { "type": "string", "nullable": true }, "fileLink": { "type": "string", "nullable": true }, "fileLength": { "type": "integer", "format": "int32" }, "createdUserId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FileResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FileResponseModel" }, "nullable": true } }, "additionalProperties": false }, "ForbiddenWord": { "type": "object", "properties": { "word": { "maxLength": 50, "type": "string", "nullable": true }, "isRegex": { "type": "boolean" }, "isCaseSensitive": { "type": "boolean" } }, "additionalProperties": false }, "ForbiddenWordConfig": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "words": { "type": "array", "items": { "$ref": "#/components/schemas/ForbiddenWord" }, "description": "An array of words (or regexes) to be forbidden from emails and chat messages.", "nullable": true }, "isEnabled": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FuzzinessTolerance": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "GenAiConfigDto": { "type": "object", "properties": { "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "enabled": { "type": "boolean" }, "aiBotId": { "type": "integer", "format": "int64", "nullable": true }, "maxResponseTokens": { "type": "integer", "format": "int32" }, "idleWarningMinutes": { "type": "integer", "format": "int32" }, "idleCloseMinutes": { "type": "integer", "format": "int32" }, "selectedDeskIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "Read DTO for the gen-ai interactive support agent configuration. Returned by both the admin\r\nendpoint (`/v1/admin/genai/config`) and the internal endpoint (`/api/genai/config`).\r\n \r\nEvery tuning field here is the EFFECTIVE value, already resolved server-side: the brand's own\r\noverride, else the brand's copilot row, else the platform default. A consumer never has to\r\nknow the layering existed, and never has to look anything up of its own.\r\n \r\nThere is no defaults DTO: a brand with no row yields no DTO at all. That is the deliberate\r\ndivergence from Infoset.Types.Models.Admin.CopilotConfigDto, whose service fabricates one when nothing is\r\npersisted — here, \"never configured\" must stay distinguishable from \"configured and off\"." }, "GenAiHandoffRequestDto": { "type": "object", "properties": { "aiBotId": { "type": "integer", "format": "int64" }, "reason": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true }, "transferMessageId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Wire body for `POST /api/chat/rooms/{roomId}/genai-handoff`, the assistant handing a live\r\nconversation back to a human. `accountId` and `departmentId` travel as query parameters,\r\nmatching the ownership claim on the sibling route." }, "GenAiHandoffResponseDto": { "type": "object", "properties": { "released": { "type": "boolean" }, "dispatched": { "type": "boolean" }, "alreadyHandled": { "type": "boolean" } }, "additionalProperties": false, "description": "Wire response for the handoff." }, "GenAiOwnershipRequestDto": { "type": "object", "properties": { "aiBotId": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Wire body for `POST /api/chat/rooms/{roomId}/genai-owner`, the assistant's ownership claim.\r\n`accountId` and `departmentId` travel as query parameters, so the body carries only the\r\ncaller's identity." }, "GenAiOwnershipResponseDto": { "type": "object", "properties": { "owned": { "type": "boolean" }, "roomId": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Wire response for the ownership claim.\r\n \r\n`owned: false` is a normal outcome, not an error: it means somebody else holds the room —\r\ntypically a human agent assigned between the caller's last check and this call — and the caller\r\nmust withdraw, publish nothing, and leave the conversation alone." }, "GenAiResolveRequestDto": { "type": "object", "properties": { "aiBotId": { "type": "integer", "format": "int64" }, "summary": { "type": "string", "nullable": true }, "idempotencyKey": { "type": "string", "nullable": true }, "closeMessageId": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Wire body for `POST /api/chat/rooms/{roomId}/genai-resolve`: the assistant closing a\r\nconversation it holds and marking it solved. `accountId` and `departmentId` travel as\r\nquery parameters, matching the ownership and handoff routes." }, "GenAiResolveResponseDto": { "type": "object", "properties": { "closed": { "type": "boolean" }, "alreadyClosed": { "type": "boolean" }, "alreadyHandled": { "type": "boolean" } }, "additionalProperties": false, "description": "Wire response for the resolve." }, "GenAiTypingRequestDto": { "type": "object", "properties": { "isTyping": { "type": "boolean" } }, "additionalProperties": false, "description": "Wire body for `POST /api/chat/rooms/{roomId}/typing`, the relay that lets a process outside\r\nnetcore raise and lower the visitor's typing indicator. `accountId` and `departmentId`\r\ntravel as query parameters, so the body carries only the flag." }, "GenAiTypingResponseDto": { "type": "object", "properties": { "sent": { "type": "boolean" } }, "additionalProperties": false, "description": "Wire response for the typing relay. `sent` is a DIAGNOSTIC, not a delivery guarantee: the\r\nrelay computes it from its own reads of the connection room and the account's connections, taken\r\naround the hub call rather than inside it, because the hub method reports no recipient count." }, "HelpdeskArticle": { "required": [ "desk", "user" ], "type": "object", "properties": { "_id": { "type": "integer", "format": "int64", "nullable": true }, "title": { "type": "string", "nullable": true }, "spoiler": { "type": "string", "description": "Spoiler displayed under the title", "nullable": true }, "language": { "type": "string", "description": "2-letter language code", "nullable": true }, "body": { "type": "string", "description": "Body of the article in Markdown format", "nullable": true }, "user": { "$ref": "#/components/schemas/HelpdeskArticleUser" }, "isDraft": { "type": "boolean", "description": "Whether this is a draft article", "nullable": true }, "slug": { "type": "string", "description": "Auto-generated URL slug of the article, e.g. infoset.help/acmeinc/articles/{id}-{slug}", "nullable": true }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticleRate" }, "nullable": true }, "stats": { "$ref": "#/components/schemas/ArticleStats" }, "desk": { "minLength": 1, "type": "string", "description": "ID of the help center of this article" }, "departmentId": { "type": "integer", "format": "int64", "nullable": true }, "previous": { "$ref": "#/components/schemas/HelpdeskArticle" }, "collection": { "type": "integer", "description": "ID of the collection of this article", "format": "int64", "nullable": true }, "createdAt": { "description": "Creation date", "nullable": true }, "updatedAt": { "description": "Last update date", "nullable": true } }, "additionalProperties": false }, "HelpdeskArticleQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskArticle" }, "nullable": true } }, "additionalProperties": false }, "HelpdeskArticleRate": { "type": "object", "properties": { "visitor": { "description": "Details about the rater, at least contains the `id` of the visitor", "nullable": true }, "rate": { "type": "number", "description": "Rate, one of -1, 0, 1", "format": "double", "nullable": true }, "createdAt": { "description": "Creation date", "nullable": true }, "updatedAt": { "description": "Last update date", "nullable": true } }, "additionalProperties": false }, "HelpdeskArticleUser": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the user", "nullable": true }, "email": { "type": "string", "description": "email of the user", "nullable": true }, "avatarUrl": { "type": "string", "description": "Avatar URL of the user", "nullable": true } }, "additionalProperties": false }, "HelpdeskChatWidgetSettings": { "type": "object", "properties": { "apiKey": { "type": "string", "description": "API key of the chat widget to display on the help center", "nullable": true }, "settings": { "description": "Other custom settings to provide to the chat widget", "nullable": true } }, "additionalProperties": false }, "HelpdeskCollection": { "required": [ "desk", "title" ], "type": "object", "properties": { "_id": { "type": "integer", "format": "int64", "nullable": true }, "icon": { "type": "string", "description": "Icon displayed on the collection card, it must be a Font Awesome 5 icon classname, e.g. \"fas fa-search\"", "nullable": true }, "title": { "type": "string" }, "spoiler": { "type": "string", "description": "Spoiler displayed under the title", "nullable": true }, "language": { "type": "string", "description": "2-letter language code", "nullable": true }, "sections": { "type": "array", "items": { "type": "string" }, "nullable": true }, "order": { "type": "integer", "description": "Order of the collection in the homepage, if not given creation date will be used", "format": "int64", "nullable": true }, "slug": { "type": "string", "description": "Auto-generated URL slug of the collection, e.g. infoset.help/acmeinc/collections/{id}-{slug}", "nullable": true }, "desk": { "type": "string", "description": "ID of the help center of this collection" }, "departmentId": { "type": "integer", "format": "int64", "nullable": true }, "previous": { "$ref": "#/components/schemas/HelpdeskCollection" }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionArticle" }, "nullable": true }, "createdAt": { "description": "Creation date", "nullable": true }, "updatedAt": { "description": "Last update date", "nullable": true } }, "additionalProperties": false }, "HelpdeskCollectionQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/HelpdeskCollection" }, "nullable": true } }, "additionalProperties": false }, "HelpdeskFooterLink": { "type": "object", "properties": { "title": { "type": "string", "description": "Label to display", "nullable": true }, "url": { "type": "string", "description": "URL for the link", "nullable": true } }, "additionalProperties": false }, "HelpdeskInfosetData": { "required": [ "apiKey", "id" ], "type": "object", "properties": { "apiKey": { "type": "string", "description": "infoset account api key" }, "id": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "HelpdeskIntegration": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Plausible integration is enabled", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationAmplitude": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Amplitude integration is enabled", "nullable": true }, "apiKey": { "type": "string", "description": "Amplitude project API Key to track events in your help center", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationCommento": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Commento integration is enabled", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationDiscourse": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Discourse integration is enabled", "nullable": true }, "url": { "type": "string", "description": "Discourse URL for integration", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationDisqus": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Disqus integration is enabled", "nullable": true }, "shortname": { "type": "string", "description": "Disqus shortname for integration", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationFathom": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Fathom integration is enabled", "nullable": true }, "siteId": { "type": "string", "description": "Fathom tracking Site ID to track events in your help center", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationGa": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Google Analytics integration is enabled", "nullable": true }, "id": { "type": "string", "description": "Google Analytics ID to track events in your help center", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationMomently": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Momently integration is enabled", "nullable": true }, "siteId": { "type": "string", "description": "Momently Site ID to track events in your help center", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationSegment": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Segment integration is enabled", "nullable": true }, "writeKey": { "type": "string", "description": "Segment project Write Key to track events in your help center", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrationSimpleAnalytics": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether Simple Analytics integration is enabled", "nullable": true } }, "additionalProperties": false }, "HelpdeskIntegrations": { "type": "object", "properties": { "googleAnalytics": { "$ref": "#/components/schemas/HelpdeskIntegrationGa" }, "segment": { "$ref": "#/components/schemas/HelpdeskIntegrationSegment" }, "amplitude": { "$ref": "#/components/schemas/HelpdeskIntegrationAmplitude" }, "simpleAnalytics": { "$ref": "#/components/schemas/HelpdeskIntegrationSimpleAnalytics" }, "plausible": { "$ref": "#/components/schemas/HelpdeskIntegration" }, "fathom": { "$ref": "#/components/schemas/HelpdeskIntegrationFathom" }, "momently": { "$ref": "#/components/schemas/HelpdeskIntegrationMomently" }, "disqus": { "$ref": "#/components/schemas/HelpdeskIntegrationDisqus" }, "commento": { "$ref": "#/components/schemas/HelpdeskIntegrationCommento" }, "discourse": { "$ref": "#/components/schemas/HelpdeskIntegrationDiscourse" } }, "additionalProperties": false }, "HelpdeskLanguageSettings": { "required": [ "language" ], "type": "object", "properties": { "language": { "type": "string", "description": "2-letter language code" }, "title": { "type": "string", "description": "Title of the help center for this language", "nullable": true }, "subtitle": { "type": "string", "description": "Subtitle of the help center for this language", "nullable": true }, "chatWidget": { "$ref": "#/components/schemas/HelpdeskChatWidgetSettings" } }, "additionalProperties": false }, "HelpdeskSocialLink": { "type": "object", "properties": { "platform": { "type": "string", "description": "Platform of the social link, i.e. \"facebook\", \"twitter\", \"linkedin\"", "nullable": true }, "url": { "type": "string", "description": "URL for the link, provide just the sub-routes for Facebook or LinkedIn, e.g. for\r\n\"https://www.linkedin.com/company/acmeinc\" provide\r\n\"company/acmeinc\"", "nullable": true } }, "additionalProperties": false }, "IVRDetailMenu": { "required": [ "actionType", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "ivrMenuId": { "type": "integer", "description": "IVR Menü Id", "format": "int64" }, "number": { "type": "string", "description": "Tuşlanan Numara; Tek numara yada xxx-yyy arası numaralar gibi, boş ise tuşlama yok durumu", "nullable": true }, "name": { "minLength": 1, "type": "string", "description": "Menü Adı" }, "wavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "actionType": { "type": "integer", "description": "Yapılacak İşlem\r\n0: Dahiliye Aktar\r\n1: Dahili Posta Kutusuna Aktar\r\n2: Çağrı Merkezi Grubuna Aktar\r\n3: Çağrı Merkezi Grubu Posta Kutusuna Aktar\r\n4: Numaraya Aktar\r\n5: Başka Menüye Geç\r\n6: Menüyü Tekrar Et\r\n7: Dil Değiştir(Ses Dizini Değiştir)\r\n8: Hattı Kapat", "format": "int32" }, "actionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "status": { "type": "integer", "description": "1:aktif, 0:pasif", "format": "int32" }, "accountId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "IVRDetailMenuQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IVRDetailMenu" }, "nullable": true } }, "additionalProperties": false }, "IVRMenu": { "required": [ "name", "virtualExtNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/IVRDetailMenu" }, "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "IVR Menü Adı" }, "virtualExtNumber": { "minLength": 1, "type": "string", "description": "Sanal Dahili Numarası" }, "reportHeader": { "type": "string", "description": "Rapor Başlık Adı", "nullable": true }, "entryWavFile": { "type": "string", "description": "Menü Girişi Wav Dosyası", "nullable": true }, "menuWavFile": { "type": "string", "description": "Menü Wav Dosyası", "nullable": true }, "dtmfWaitTime": { "type": "integer", "description": "ms Cinsinden Tuş Bekleme Süresi", "format": "int32" }, "menuRepeatCount": { "type": "integer", "description": "Menü Tekrar Dinletme Sayısı", "format": "int32" }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "IVRMenuQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IVRMenu" }, "nullable": true } }, "additionalProperties": false }, "InfosetPlan": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "billingRecurs": { "type": "integer", "description": "Faturalandırma her 1 ayda, yada her 1 yılda", "format": "int32" }, "billingUnit": { "$ref": "#/components/schemas/BillingUnit" } }, "additionalProperties": false }, "InfosetPlanPacket": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "code": { "type": "string", "nullable": true }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "billingUnit": { "$ref": "#/components/schemas/BillingUnit" } }, "additionalProperties": false }, "InfosetPlanResource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "maxGroups": { "type": "integer", "format": "int32" }, "maxContacts": { "type": "integer", "format": "int32" }, "maxCompanies": { "type": "integer", "format": "int32" }, "isDealActive": { "type": "boolean" }, "maxDeals": { "type": "integer", "format": "int32" }, "isTicketActive": { "type": "boolean" }, "maxTickets": { "type": "integer", "format": "int32" }, "isChatActive": { "type": "boolean" }, "isChatFileshareActive": { "type": "boolean" }, "maxChatWidgets": { "type": "integer", "format": "int32" }, "chatMessageHistoryDays": { "type": "integer", "description": "How long the chat messages will be stored, 0 means always", "format": "int32" }, "isBusinessHourActive": { "type": "boolean" }, "isOutboundMessageActive": { "type": "boolean" }, "isChatbotActive": { "type": "boolean" }, "isMailActive": { "type": "boolean" }, "maxMailAccounts": { "type": "integer", "format": "int32" }, "isCallcenterActive": { "type": "boolean" }, "callcenterConcurrentCalls": { "type": "integer", "format": "int32" }, "maxAgents": { "type": "integer", "format": "int32" }, "isCallcenterReportActive": { "type": "boolean" }, "maxExtNumbers": { "type": "integer", "format": "int32" }, "isCallLogActive": { "type": "boolean" }, "isVoicemailActive": { "type": "boolean" }, "isAutodialerActive": { "type": "boolean" }, "autodialerConcurrentCalls": { "type": "integer", "format": "int32" }, "maxUsers": { "type": "integer", "format": "int32" }, "maxDesks": { "type": "integer", "format": "int32" }, "maxFileStorage": { "type": "number", "description": "Max allowed file storage (gb)", "format": "float" } }, "additionalProperties": false }, "InsertBulkError": { "type": "object", "properties": { "row": { "type": "integer", "description": "Starts from 0, the index of the element in the list that caused the error", "format": "int64" }, "error": { "type": "string", "description": "Error message", "nullable": true } }, "additionalProperties": false }, "InsertBulkResponse": { "type": "object", "properties": { "inserted": { "type": "integer", "format": "int64" }, "updated": { "type": "integer", "format": "int64" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/InsertBulkError" }, "nullable": true } }, "additionalProperties": false }, "IntegrationCapabilityChannelResponseModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationCapabilityResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "integrationType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "displayLabel": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationCapabilityChannelResponseModel" }, "nullable": true } }, "additionalProperties": false }, "IntegrationCapabilityResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationCapabilityResponseModel" }, "nullable": true } }, "additionalProperties": false }, "IntentFreqDto": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "An intent label and how often it has occurred for the contact." }, "KbSyncPlanAccount": { "type": "object", "properties": { "accountId": { "type": "integer", "format": "int64" }, "departments": { "type": "array", "items": { "$ref": "#/components/schemas/KbSyncPlanDepartment" }, "nullable": true }, "selections": { "type": "array", "items": { "$ref": "#/components/schemas/KbSyncPlanSelection" }, "nullable": true } }, "additionalProperties": false, "description": "One account in the sync plan. `Departments` lists every brand row (active AND\r\npassive — the updater purges by status). `Selections` lists the per-brand Copilot\r\ndesk selections; an account can have selections with no matching department row (config\r\ncreated before the department, or the account-level dept-0 default)." }, "KbSyncPlanDepartment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "A department (brand) row. `Status` is the wire status code: `\"A\"` = active,\r\n`\"P\"` = passive. Passive rows are included so the updater can purge their KB." }, "KbSyncPlanResponse": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/KbSyncPlanAccount" }, "nullable": true } }, "additionalProperties": false, "description": "Response for `GET /api/ai/kb-sync-plan` — the cross-tenant reconciliation plan\r\nthe helpdesk-updater pulls to decide which knowledge-base departments to keep, purge,\r\nor resync per account. Desk→department mapping is intentionally NOT here: it lives in\r\nthe helpdesk service and the updater fetches it there. This endpoint is DB-only.\r\n \r\nBoth serializer attributes are present on every field: Infoset.Api serializes with\r\nNewtonsoft.Json (AddNewtonsoftJson in Startup), so [JsonProperty] drives the wire\r\nshape, while [JsonPropertyName] keeps System.Text.Json consumers (ad-hoc test\r\ndeserialisers) in sync. camelCase matches the sibling internal responses." }, "KbSyncPlanSelection": { "type": "object", "properties": { "departmentId": { "type": "integer", "format": "int64" }, "selectedDeskIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false, "description": "A per-brand Copilot desk selection from `copilot_config`. `DepartmentId` 0 is\r\nthe account-level default row. `SelectedDeskIds` semantics mirror the DB column:\r\n`null` (NULL column) = all desks; `[]` (empty string) = no desks; otherwise the\r\nparsed CSV of desk ids." }, "LinkedNote": { "required": [ "notes" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" }, "notes": { "maxLength": 1000, "minLength": 1, "type": "string" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "accountId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "LinkedNoteCreateModel": { "required": [ "notes" ], "type": "object", "properties": { "notes": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "LinkedNoteQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedNote" }, "nullable": true } }, "additionalProperties": false }, "LongOpenTicketDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "ageDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "The longest-open ticket, with its subject and age in days." }, "MailAccount": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "incomingServer": { "type": "string", "nullable": true }, "incomingLoginName": { "type": "string", "nullable": true }, "incomingLoginPassword": { "type": "string", "nullable": true }, "incomingPort": { "type": "integer", "format": "int32" }, "serverType": { "$ref": "#/components/schemas/MailIncomingServerType" }, "incomingSecureMethod": { "type": "string", "nullable": true }, "incomingMailDeduplicateSubject": { "type": "integer", "format": "int32" }, "pipelineId": { "type": "integer", "format": "int64", "nullable": true }, "stageId": { "type": "integer", "format": "int64", "nullable": true }, "outgoingServer": { "type": "string", "nullable": true }, "outgoingLoginName": { "type": "string", "nullable": true }, "outgoingLoginPassword": { "type": "string", "nullable": true }, "outgoingPort": { "type": "integer", "format": "int32" }, "outgoingSecureMethod": { "type": "string", "nullable": true }, "fromName": { "type": "string", "nullable": true }, "fromEmail": { "type": "string", "nullable": true }, "connectionStatus": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/MailAccountVisibility" }, "visibleTo": { "maxLength": 1000, "type": "string", "description": "user ID or user group IDs that can see this mail account\r\nif null, it's visible to the entire company", "nullable": true }, "oauthCredentials": { "type": "string", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "lastActivityTime": { "type": "string", "format": "date-time", "nullable": true }, "defaultPipelineIds": { "type": "string", "description": "Comma-separated pipeline IDs that this mail account is the default for\r\ne.g. \"1,5,12\"", "nullable": true }, "lastUid": { "type": "integer", "description": "Last processed IMAP UID for this mail account", "format": "int64", "nullable": true }, "uidValidity": { "type": "integer", "description": "IMAP UidValidity - if this changes, LastUid becomes invalid", "format": "int64", "nullable": true } }, "additionalProperties": false }, "MailAccountQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/MailAccount" }, "nullable": true } }, "additionalProperties": false }, "MailAccountVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "MailIncomingServerType": { "enum": [ 0, 1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "MergedTicketLink": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "primary": { "type": "boolean" } }, "additionalProperties": false }, "MfaMethod": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "Defines multi-factor authentication methods

Enum values:

", "format": "int32" }, "NewMessageModel": { "type": "object", "properties": { "sender": { "$ref": "#/components/schemas/ChatVisitorDataItem" }, "message": { "$ref": "#/components/schemas/ChatMessageItem" }, "integrationId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "NonGrantableCombination": { "type": "object", "properties": { "module": { "enum": [ 100, 201, 202, 203, 204, 300, 301, 302, 310, 311, 312, 313, 314, 315, 318, 321, 322, 323, 324, 325, 326, 327, 328, 340, 341, 362, 363, 364, 365, 366, 375, 400, 500, 501, 601, 602, 603, 604, 605, 610, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 700, 701, 702, 703, 801, 802, 803, 900, 901 ], "type": "integer", "description": "

Enum values:

" }, "action": { "$ref": "#/components/schemas/AuthorizedAction" } }, "additionalProperties": false }, "NonGrantableRightsDescriptor": { "type": "object", "properties": { "combinations": { "type": "array", "items": { "$ref": "#/components/schemas/NonGrantableCombination" }, "description": "Explicit (module, action) pairs a custom profile may never grant.", "nullable": true }, "modules": { "type": "array", "items": { "enum": [ 100, 201, 202, 203, 204, 300, 301, 302, 310, 311, 312, 313, 314, 315, 318, 321, 322, 323, 324, 325, 326, 327, 328, 340, 341, 362, 363, 364, 365, 366, 375, 400, 500, 501, 601, 602, 603, 604, 605, 610, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 700, 701, 702, 703, 801, 802, 803, 900, 901 ], "type": "integer", "description": "

Enum values:

" }, "description": "IDT-1150: whole modules non-grantable in ANY action (View included) — the Owner / Owner+GA monopoly.\r\nThe custom-profile editor must not list these modules at all.", "nullable": true }, "superadminBandModuleThreshold": { "type": "integer", "description": "Every module whose id is >= this threshold (the SuperAdmin band) is non-grantable in any action,\r\nso the client can grey the whole band out without the server enumerating each superadmin module.", "format": "int32" }, "recordingDownloadNonGrantable": { "type": "boolean", "description": "Recording download (SAVE_AS / \"İndir\") — now GRANTABLE to a custom profile. Frozen at false (computed,\r\nnot settable) so existing clients keying off this flag re-enable the download column without a contract\r\nbreak, and no future edit can flip it back by mistake.", "readOnly": true }, "recordingDeleteNonGrantable": { "type": "boolean", "description": "Recording delete (\"Sil\") is non-grantable to a custom profile on both the per-VoIP-user and\r\nper-external-number recording axes. Replaced download as the restricted recording action." }, "pendingKeys": { "type": "array", "items": { "type": "string" }, "description": "Conceptually non-grantable rights that do not yet have a Infoset.Types.RightModule (see\r\nInfoset.Types.Authorization.NonGrantableRights.PendingNonGrantableKeys); listed so the client knows they exist.", "nullable": true } }, "additionalProperties": false, "description": "IDT-1082 (S8): the client-facing description of the non-grantable (⛔) policy, so the custom-profile\r\neditor can render the affected module/action cells as faded/disabled. Built solely from\r\nInfoset.Types.Authorization.NonGrantableRights — it carries no new policy, only a serialisable view of the existing set." }, "Notification": { "required": [ "content", "type", "userId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "type": { "minLength": 1, "type": "string" }, "content": { "minLength": 1, "type": "string" }, "actorId": { "type": "integer", "format": "int64", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "readAt": { "type": "string", "format": "date-time", "nullable": true }, "emailSentAt": { "type": "string", "format": "date-time", "nullable": true }, "departmentId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "NotificationQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" }, "nullable": true } }, "additionalProperties": false }, "NotificationType": { "enum": [ 0, 1, 2, 3, 10, 11, 12, 20, 21, 22, 41, 42, 43, 61, 62, 63, 71, 80, 81, 82, 83, 100 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "OfferSettings": { "type": "object", "properties": { "offerEnabled": { "type": "boolean" }, "offerTtlSeconds": { "maximum": 120, "minimum": 30, "type": "integer", "format": "int32" }, "rejectAllowed": { "type": "boolean" } }, "additionalProperties": false }, "OkResult": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OpenTicketDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "ageDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "An open ticket, with its subject and age in days." }, "OutboundMessage": { "required": [ "data", "filters" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OutboundMessageData" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundMessageFilter" } } }, "additionalProperties": false }, "OutboundMessageAction": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "OutboundMessageData": { "required": [ "name", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "type": { "$ref": "#/components/schemas/OutboundMessageType" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "message": { "type": "string", "nullable": true }, "runCount": { "type": "integer", "format": "int32" }, "workingHourType": { "type": "integer", "description": "Çalışma Saatleri Seçeneği 0:Yok, 1: Sistem Ayarları Mesai Saati Kullan, 2: Özel Mesai Saati Kullan, 3:Mesai saatleri\r\ndışı, 4:Agentlar aktif olduğunda aktif", "format": "int32" }, "sendType": { "$ref": "#/components/schemas/OutboundMessageSendType" }, "status": { "type": "integer", "description": "0 inactive, 1 active", "format": "int32" }, "settings": { "description": "Dynamic settings depending on the message type", "nullable": true }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "lastRunAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "OutboundMessageFilter": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "messageId": { "type": "integer", "format": "int64" }, "filterType": { "$ref": "#/components/schemas/OutboundMessageFilterType" }, "filterColumn": { "type": "string", "nullable": true }, "filterValue": { "type": "string", "nullable": true }, "filterOperation": { "type": "string", "nullable": true }, "filterPrefix": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OutboundMessageFilterType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "OutboundMessageLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "messageId": { "type": "integer", "format": "int64" }, "action": { "$ref": "#/components/schemas/OutboundMessageAction" }, "actionValue": { "type": "string", "nullable": true }, "visitorId": { "type": "string", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "contactName": { "type": "string", "nullable": true }, "contactColor": { "type": "string", "nullable": true }, "contactPhoto": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OutboundMessageLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundMessageLog" }, "nullable": true } }, "additionalProperties": false }, "OutboundMessageResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "chatWidget": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/OutboundMessageType" }, "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "settings": { "nullable": true }, "runCount": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time", "nullable": true }, "endTime": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastRunAt": { "type": "string", "format": "date-time", "nullable": true }, "sent": { "type": "integer", "format": "int32" }, "opened": { "type": "integer", "format": "int32" }, "replied": { "type": "integer", "format": "int32" }, "dismissed": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "sendType": { "$ref": "#/components/schemas/OutboundMessageSendType" }, "workingHourType": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OutboundMessageResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundMessageResponseModel" }, "nullable": true } }, "additionalProperties": false }, "OutboundMessageSendType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "OutboundMessageType": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "OutboundPreviewRequestBody": { "type": "object", "properties": { "filters": { "type": "array", "items": { "$ref": "#/components/schemas/OutboundMessageFilter" }, "nullable": true }, "type": { "$ref": "#/components/schemas/OutboundMessageType" }, "settings": { "nullable": true }, "departmentId": { "type": "integer", "description": "IDT-1368: the brand the message will be sent as; the preview counts only that brand's\r\ncontacts. Server-side it is intersected with the caller's permitted brands (default-deny).", "format": "int64" } }, "additionalProperties": false }, "PermissionProfile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64", "nullable": true }, "departmentId": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "isSystem": { "type": "boolean" }, "isLicensed": { "type": "boolean" }, "createdBy": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "department": { "$ref": "#/components/schemas/Department" }, "rights": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileRight" }, "nullable": true }, "voipRights": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileVoipRight" }, "nullable": true }, "externalNumberRights": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileExternalNumberRight" }, "nullable": true } }, "additionalProperties": false }, "PermissionProfileExternalNumberRight": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "profileId": { "type": "integer", "format": "int64" }, "externalNumberId": { "type": "integer", "format": "int64" }, "view": { "type": "boolean" }, "listen": { "type": "boolean" }, "delete": { "type": "boolean" }, "saveAs": { "type": "boolean" }, "profile": { "$ref": "#/components/schemas/PermissionProfile" } }, "additionalProperties": false }, "PermissionProfileQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfile" }, "nullable": true } }, "additionalProperties": false }, "PermissionProfileRight": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "profileId": { "type": "integer", "format": "int64" }, "rightModule": { "type": "integer", "format": "int32" }, "viewRecord": { "type": "boolean" }, "editRecord": { "type": "boolean" }, "deleteRecord": { "type": "boolean" }, "newRecord": { "type": "boolean" }, "exportRecord": { "type": "boolean" }, "profile": { "$ref": "#/components/schemas/PermissionProfile" } }, "additionalProperties": false }, "PermissionProfileUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PermissionProfileUserQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionProfileUser" }, "nullable": true } }, "additionalProperties": false }, "PermissionProfileVoipRight": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "profileId": { "type": "integer", "format": "int64" }, "voipUserId": { "type": "integer", "format": "int64" }, "view": { "type": "boolean" }, "listen": { "type": "boolean" }, "delete": { "type": "boolean" }, "saveAs": { "type": "boolean" }, "profile": { "$ref": "#/components/schemas/PermissionProfile" } }, "additionalProperties": false }, "PermissionsRecord": { "type": "object", "properties": { "tblId": { "type": "integer", "format": "int64" }, "rightClass": { "type": "integer", "description": "0= Module 1:Custom rights", "format": "int32" }, "rightId": { "enum": [ 100, 201, 202, 203, 204, 300, 301, 302, 310, 311, 312, 313, 314, 315, 318, 321, 322, 323, 324, 325, 326, 327, 328, 340, 341, 362, 363, 364, 365, 366, 375, 400, 500, 501, 601, 602, 603, 604, 605, 610, 614, 615, 616, 617, 618, 619, 620, 621, 622, 623, 624, 625, 626, 627, 700, 701, 702, 703, 801, 802, 803, 900, 901 ], "type": "integer", "description": "

Enum values:

" }, "rightName": { "type": "string", "nullable": true }, "rightRecord": { "$ref": "#/components/schemas/RightRecord" } }, "additionalProperties": false }, "Pipeline": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "pipelineType": { "type": "integer", "description": "1: deal, 2:task", "format": "int32" }, "name": { "maxLength": 60, "type": "string", "nullable": true }, "status": { "maxLength": 1, "type": "string", "description": "'A': Active, 'P': Passive", "nullable": true }, "visibility": { "$ref": "#/components/schemas/PipelineVisibility" }, "userGroupIds": { "maxLength": 1000, "type": "string", "description": "user groups that can see this pipeline\r\nif null, it's visible to the entire company", "nullable": true }, "departmentIds": { "maxLength": 512, "type": "string", "description": "Comma-separated department ids this pipeline belongs to (multi-brand, IDT-465).", "nullable": true } }, "additionalProperties": false }, "PipelineQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" }, "nullable": true } }, "additionalProperties": false }, "PipelineVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "PlanType": { "enum": [ 0, 1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "PreviewCountExcludedReasons": { "type": "object", "properties": { "noEmail": { "type": "integer", "format": "int32" }, "noPhone": { "type": "integer", "format": "int32" }, "noRecentChat": { "type": "integer", "format": "int32" }, "marketingOptOut": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PreviewCountResult": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "totalMatchingFilters": { "type": "integer", "format": "int32" }, "excludedReasons": { "$ref": "#/components/schemas/PreviewCountExcludedReasons" } }, "additionalProperties": false }, "PriorityType": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "PriorityTypeFRTModel": { "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/PriorityType" }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PriorityTypeFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PriorityTypeFRTModel" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ProfileDto": { "type": "object", "properties": { "tenureMonths": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Contact profile facts. Plan was dropped from scope." }, "PublicChatCustomFieldModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "fieldName": { "type": "string", "nullable": true }, "fieldType": { "type": "string", "nullable": true }, "fieldOptions": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PublicChatbotModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "firstMessage": { "type": "string", "nullable": true }, "publishedVersionId": { "type": "integer", "format": "int64" }, "workingHourType": { "type": "integer", "format": "int32" }, "departmentId": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "description": "Used in return values of public endpoints like /chat/widget" }, "QueryOperator": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "QueryPrefix": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ReminderType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ReportAvailabilityModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "totalDuration": { "type": "number", "format": "double" }, "avgDuration": { "type": "number", "format": "double" }, "avgQueueTime": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportAvailabilityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportAvailabilityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCCAgentPerformanceModel": { "type": "object", "properties": { "departmentId": { "type": "integer", "format": "int64" }, "forDate": { "type": "string", "description": "Gün yada Ay", "format": "date-time", "nullable": true }, "firstActivityTime": { "type": "string", "description": "Günlük olarak oluşan raporlarda çağrı merkezine ilk işlem zamanı, çağrı merkezinde aktif moda geçiş yaptı gibi", "format": "date-time", "nullable": true }, "firstActivityState": { "type": "integer", "description": "İlk işlem durumu, 0: Passive,1: Active,2: Idle, 3: outboud, 4: Midday", "format": "int32", "nullable": true }, "lastActivityTime": { "type": "string", "description": "Günlük olarak oluşan raporlarda çağrı merkezine son işlem zamanı, çağrı merkezinde pasif moda geçiş yaptı gibi", "format": "date-time", "nullable": true }, "lastActivityState": { "type": "integer", "description": "Son işlem durumu, 0: Passive,1: Active,2: Idle, 3: outboud, 4: Midday", "format": "int32", "nullable": true }, "queueName": { "type": "string", "description": "Çağrı merkezi kuyruğu", "nullable": true }, "voipUserId": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "extNumber": { "type": "string", "description": "Dahili numara", "nullable": true }, "inboundCallCount": { "type": "integer", "description": "Gelen başarılı çağrı sayısı", "format": "int64" }, "inboundMissedCallCount": { "type": "integer", "description": "Gelen cevapsız çağrı sayısı (agent için kaçan çağrıdır)", "format": "int64" }, "outboundCallCount": { "type": "integer", "description": "Giden başarılı çağrı sayısı", "format": "int64" }, "outboundMissedCallCount": { "type": "integer", "description": "Giden cevapsız çağrı sayısı", "format": "int64" }, "inboundCallSetupSuccessRate": { "type": "number", "description": "Gelen başarılı çağrı oranı, gelen başarılı çağrı/gelen toplam çağrı", "format": "float" }, "outboundCallSetupSuccessRate": { "type": "number", "description": "Giden başarılı çağrı oranı, gelen başarılı çağrı/gelen toplam çağrı", "format": "float" }, "inboundProductivityRate": { "type": "number", "description": "Operatör verimliliği, toplam konuşma süresi / oturumun açık kaldığı süre", "format": "float" }, "inboundCallTime": { "type": "integer", "description": "Gelen çağrı süresi toplamı, ms cisinsinden", "format": "int64" }, "inboundLongestCallTime": { "type": "integer", "description": "Gelen en uzun çağrı süresi, ms cinsinden", "format": "int32" }, "inboundCallRingTime": { "type": "integer", "description": "Agent zil çaldırma süresi toplamı, ms", "format": "int64" }, "inboundAvgCallTime": { "type": "number", "description": "Gelen çağrı süresi ortalaması, ms cisinsinden", "format": "float" }, "inboundAvgCallRingTime": { "type": "integer", "description": "Agent zil çaldırma süresi ortalaması, ms", "format": "int32" }, "outboundCallTime": { "type": "integer", "description": "Giden çağrı süresi toplamı, ms cisinsinden", "format": "int64" }, "outboundCallRingTime": { "type": "integer", "description": "Giden çağrı zil çaldırma süresi toplamı, ms", "format": "int64" }, "outboundAvgCallTime": { "type": "number", "description": "Giden çağrı süresi ortalaması, ms cisinsinden", "format": "float" }, "outboundAvgCallRingTime": { "type": "number", "description": "Giden çağrı zil çaldırma süresi ortalaması, ms", "format": "float" }, "activeTime": { "type": "integer", "description": "Aktif mod süresi toplamı", "format": "int64" }, "idleTime": { "type": "integer", "description": "Mola mod süresi toplamı", "format": "int64" }, "outboundTime": { "type": "integer", "description": "Dış arama mod süresi toplamı", "format": "int64" }, "middayTime": { "type": "integer", "description": "Öğle tatili/yemek mod süresi toplamı", "format": "int64" }, "callWaitTime": { "type": "integer", "description": "Agent boşta çağrı bekleme süresi, (aktif mod süresi+dış arama süresi)-(toplam gelen çağrı süresi+toplam giden çağrı\r\nsüresi)", "format": "int64" } }, "additionalProperties": false }, "ReportCCAgentPerformanceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCCAgentPerformanceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCCAgentProductivityRateModel": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "activeTime": { "type": "integer", "format": "int64" }, "inboundCallTime": { "type": "integer", "format": "int64" }, "productivityRate": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ReportCCAgentProductivityRateModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCCAgentProductivityRateModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCSATRateByUserModel": { "type": "object", "properties": { "user": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "avgRate": { "type": "number", "format": "double" }, "totalVeryUnsatisfied": { "type": "integer", "format": "int32" }, "totalUnsatisfied": { "type": "integer", "format": "int32" }, "totalNeutral": { "type": "integer", "format": "int32" }, "totalSatisfied": { "type": "integer", "format": "int32" }, "totalVerySatisfied": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportCSATRateByUserModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCSATRateByUserModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCSATRateDailyModel": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "avgRate": { "type": "number", "format": "double" }, "totalVeryUnsatisfied": { "type": "integer", "format": "int32" }, "totalUnsatisfied": { "type": "integer", "format": "int32" }, "totalNeutral": { "type": "integer", "format": "int32" }, "totalSatisfied": { "type": "integer", "format": "int32" }, "totalVerySatisfied": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportCSATRateDailyModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCSATRateDailyModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCSATRateModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "logTime": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double" }, "data": { "type": "string", "nullable": true }, "linkedId": { "type": "integer", "format": "int64" }, "agent": { "type": "integer", "format": "int64" }, "agentName": { "type": "string", "nullable": true }, "actor": { "type": "integer", "format": "int64" }, "actorName": { "type": "string", "nullable": true }, "actorPhoneNumber": { "type": "string", "nullable": true }, "actorEmail": { "type": "string", "nullable": true }, "actorType": { "$ref": "#/components/schemas/FeedbackActorType" } }, "additionalProperties": false }, "ReportCSATRateModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCSATRateModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCSATRateOverviewModel": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "avgRate": { "type": "number", "format": "double" }, "satisfiedRate": { "type": "number", "format": "double" }, "totalVeryUnsatisfied": { "type": "integer", "format": "int32" }, "totalUnsatisfied": { "type": "integer", "format": "int32" }, "totalNeutral": { "type": "integer", "format": "int32" }, "totalSatisfied": { "type": "integer", "format": "int32" }, "totalVerySatisfied": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportCSATRateOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCSATRateOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCallLogModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userRatingId": { "type": "integer", "format": "int64", "nullable": true }, "userRatingScore": { "type": "number", "format": "double", "nullable": true }, "userRatingMessage": { "type": "string", "nullable": true }, "visitorFeedbackId": { "type": "integer", "format": "int64", "nullable": true }, "visitorFeedbackRate": { "type": "number", "format": "double", "nullable": true }, "eventTime": { "type": "string", "format": "date-time" }, "callDuration": { "type": "integer", "format": "int32" }, "ringDuration": { "type": "integer", "format": "int32" }, "sourceType": { "$ref": "#/components/schemas/CallSourceType" }, "sourceId": { "type": "integer", "format": "int64" }, "destinationType": { "$ref": "#/components/schemas/CallDestinationType" }, "destinationId": { "type": "integer", "format": "int64" }, "eventType": { "$ref": "#/components/schemas/CallStatus" }, "callDirection": { "$ref": "#/components/schemas/CallDirectionType" }, "recordStatus": { "type": "integer", "description": "0 = Ses Kaydı Yok, 1 = Ses Kaydı Var ve Sıkıştırılmamış, 2 = Ses Kaydı Var ve Sıkıştırılmış", "format": "int32" }, "callerName": { "type": "string", "nullable": true }, "callerNumber": { "type": "string", "nullable": true }, "calledName": { "type": "string", "nullable": true }, "calledNumber": { "type": "string", "nullable": true }, "dialedNumber": { "type": "string", "nullable": true }, "dtmf": { "type": "string", "nullable": true }, "directory": { "type": "string", "nullable": true }, "sourceIpAddress": { "type": "string", "nullable": true }, "destinationIpAddress": { "type": "string", "nullable": true }, "tagIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportCallLogModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCallLogModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCallLogOverviewModel": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "totalCurrentWeek": { "type": "integer", "format": "int32" }, "totalLastWeek": { "type": "integer", "format": "int32" }, "totalCurrentMonth": { "type": "integer", "format": "int32" }, "totalLastMonth": { "type": "integer", "format": "int32" }, "totalDuration": { "type": "number", "format": "float" }, "avgDuration": { "type": "number", "format": "float" }, "totalDurationCurrentWeek": { "type": "number", "format": "float" }, "totalDurationLastWeek": { "type": "number", "format": "float" }, "totalDurationLastMonth": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ReportCallLogOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportCallLogOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportCategory": { "enum": [ 1, 2, 3, 4, 5 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ReportChatQueueAbandonModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "logTime": { "type": "string", "nullable": true }, "visitor": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportChatQueueAbandonModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportChatQueueAbandonModel" }, "nullable": true } }, "additionalProperties": false }, "ReportChatSummaryModel": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "solved": { "type": "integer", "format": "int32" }, "totalResponseTime": { "type": "string", "nullable": true }, "totalTime": { "type": "string", "nullable": true }, "totalResponseTimeMin": { "type": "integer", "format": "int32" }, "totalTimeMin": { "type": "integer", "format": "int32" }, "avgTotalResponseTimeSec": { "type": "number", "format": "float" }, "avgTotalTimeSec": { "type": "number", "format": "float" }, "avgTotalResponseTime": { "type": "string", "nullable": true }, "avgTotalTime": { "type": "string", "nullable": true }, "frSla": { "type": "number", "format": "double" }, "nrSla": { "type": "number", "format": "double" }, "resolutionSla": { "type": "number", "format": "double" }, "slaBreaches": { "type": "integer", "format": "int32" }, "slaChats": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportChatSummaryModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportChatSummaryModel" }, "nullable": true } }, "additionalProperties": false }, "ReportChatVisitorProfileModel": { "type": "object", "properties": { "totalBrowserType": { "type": "array", "items": { "$ref": "#/components/schemas/ReportVisitorType" }, "nullable": true }, "totalClientOs": { "type": "array", "items": { "$ref": "#/components/schemas/ReportVisitorType" }, "nullable": true } }, "additionalProperties": false }, "ReportChatbotOverviewModel": { "type": "object", "properties": { "totalChats": { "type": "integer", "format": "int32" }, "totalSolved": { "type": "integer", "format": "int32" }, "avgTotalTimeSec": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ReportChatbotOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportChatbotOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportDealOverviewModel": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "avgWinTime": { "type": "integer", "format": "int32" }, "overdueDeals": { "type": "integer", "format": "int32" }, "openDeals": { "type": "integer", "format": "int32" }, "totalOpenedDeals": { "type": "integer", "format": "int32" }, "totalWonDeals": { "type": "integer", "format": "int32" }, "totalLostDeals": { "type": "integer", "format": "int32" }, "openedDealsValue": { "type": "number", "format": "double" }, "wonDealsValue": { "type": "number", "format": "double" }, "lostDealsValue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportDealOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDealOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportDealPipelineModel": { "type": "object", "properties": { "pipelinesName": { "type": "string", "nullable": true }, "dealsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportDealPipelineModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportDealPipelineModel" }, "nullable": true } }, "additionalProperties": false }, "ReportOutboundMessageConversionModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "sent": { "type": "integer", "format": "int32" }, "opened": { "type": "integer", "format": "int32" }, "replied": { "type": "integer", "format": "int32" }, "dismissed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportOutboundMessageConversionModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportOutboundMessageConversionModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueAbandonedModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "eventTime": { "type": "string", "format": "date-time" }, "callDuration": { "type": "integer", "format": "int32" }, "ringDuration": { "type": "integer", "format": "int32" }, "eventType": { "type": "string", "nullable": true }, "sourceName": { "type": "string", "nullable": true }, "sourceNumber": { "type": "string", "nullable": true }, "dialedNumber": { "type": "string", "nullable": true }, "destinationName": { "type": "string", "nullable": true }, "destinationNumber": { "type": "string", "nullable": true }, "dtmf": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportQueueAbandonedModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueAbandonedModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueAvgWaitTimeModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "avgTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportQueueAvgWaitTimeModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueAvgWaitTimeModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueCallSummaryModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "operationDetailType": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportQueueCallSummaryModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueCallSummaryModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueSLModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "t": { "type": "integer", "format": "int32" }, "sl": { "type": "number", "format": "float" } }, "additionalProperties": false }, "ReportQueueSLModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueSLModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueTotalCallsModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "successful": { "type": "integer", "format": "int32" }, "missed": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportQueueTotalCallsModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueTotalCallsModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueTotalDurationByDayModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "forDate": { "type": "string", "nullable": true }, "inboundCallCount": { "type": "integer", "description": "Kuyruğa gelen toplam çağrı sayısı", "format": "int32" }, "inboundSuccessfulCallCount": { "type": "integer", "description": "Başarılı çağrı sayısı", "format": "int32" }, "inboundMissedCallCount": { "type": "integer", "description": "Başarısız çağrı sayısı, operatörün kaçırdıkları\r\nREPORT_CALL_CENTER_AGENT_FAILED = 63;\r\nREPORT_CALL_CENTER_AGENT_TIMEOUT = 64;", "format": "int32" }, "inboundAbandonedCallCount": { "type": "integer", "description": "Kuyrukta kaçanlar\r\nREPORT_CALL_CENTER_QUEUE_EMPTY = 68;\r\nREPORT_CALL_CENTER_QUEUE_TIMEOUT = 69;\r\nREPORT_CALL_CENTER_DIRECT_CLOSED = 70;\r\nREPORT_CALL_CENTER_QUEUE_CLOSED = 72;", "format": "int32" }, "inbound10snConnectCallCount": { "type": "integer", "description": "10 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel10sn": { "type": "number", "description": "10sn içindeki cevaplananların oranı SL10", "format": "double" }, "inbound20snConnectCallCount": { "type": "integer", "description": "20 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel20sn": { "type": "number", "description": "20sn içindeki cevaplananların oranı SL20", "format": "double" }, "inbound30snConnectCallCount": { "type": "integer", "description": "30 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel30sn": { "type": "number", "description": "30sn içindeki cevaplananların oranı SL30", "format": "double" }, "inboundAverageQueueWaitTime": { "type": "number", "description": "ms cinsinden ortalama kuyrukta bekleme süresi", "format": "double" }, "inboundMaxQueueWaitTime": { "type": "number", "description": "ms cinsinden max. kuyrukta bekleme süresi", "format": "double" }, "inboundAverageCallRingTime": { "type": "number", "description": "mn cinsinden ort. agent zil çaldırma süresi", "format": "double" }, "inboundAverageCallTime": { "type": "number", "description": "mn cinsinden ort. gelen çağrı süresi", "format": "double" } }, "additionalProperties": false }, "ReportQueueTotalDurationByDayModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueTotalDurationByDayModel" }, "nullable": true } }, "additionalProperties": false }, "ReportQueueTotalDurationModel": { "type": "object", "properties": { "queueName": { "type": "string", "nullable": true }, "inboundCallCount": { "type": "integer", "description": "Kuyruğa gelen toplam çağrı sayısı", "format": "int32" }, "inboundSuccessfulCallCount": { "type": "integer", "description": "Başarılı çağrı sayısı", "format": "int32" }, "inboundMissedCallCount": { "type": "integer", "description": "Başarısız çağrı sayısı, operatörün kaçırdıkları\r\nREPORT_CALL_CENTER_AGENT_FAILED = 63;\r\nREPORT_CALL_CENTER_AGENT_TIMEOUT = 64;", "format": "int32" }, "inboundAbandonedCallCount": { "type": "integer", "description": "Kuyrukta kaçanlar\r\nREPORT_CALL_CENTER_QUEUE_EMPTY = 68;\r\nREPORT_CALL_CENTER_QUEUE_TIMEOUT = 69;\r\nREPORT_CALL_CENTER_DIRECT_CLOSED = 70;\r\nREPORT_CALL_CENTER_QUEUE_CLOSED = 72;", "format": "int32" }, "inbound10snConnectCallCount": { "type": "integer", "description": "10 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel10sn": { "type": "number", "description": "10sn içindeki cevaplananların oranı SL10", "format": "double" }, "inbound20snConnectCallCount": { "type": "integer", "description": "20 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel20sn": { "type": "number", "description": "20sn içindeki cevaplananların oranı SL20", "format": "double" }, "inbound30snConnectCallCount": { "type": "integer", "description": "30 sn içinde cavaplananlar", "format": "int32" }, "serviceLevel30sn": { "type": "number", "description": "30sn içindeki cevaplananların oranı SL30", "format": "double" }, "inboundAverageQueueWaitTime": { "type": "number", "description": "ms cinsinden ortalama kuyrukta bekleme süresi", "format": "double" }, "inboundMaxQueueWaitTime": { "type": "number", "description": "ms cinsinden max. kuyrukta bekleme süresi", "format": "double" }, "inboundAverageCallRingTime": { "type": "number", "description": "mn cinsinden ort. agent zil çaldırma süresi", "format": "double" }, "inboundAverageCallTime": { "type": "number", "description": "mn cinsinden ort. gelen çağrı süresi", "format": "double" } }, "additionalProperties": false }, "ReportQueueTotalDurationModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportQueueTotalDurationModel" }, "nullable": true } }, "additionalProperties": false }, "ReportSlaAgentPerformanceModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "slaType": { "$ref": "#/components/schemas/SlaType" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportSlaAgentPerformanceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSlaAgentPerformanceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportSlaBreachesStatusModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/TicketStatus" }, "slaType": { "$ref": "#/components/schemas/SlaType" }, "breachRate": { "type": "number", "format": "double" }, "breachCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportSlaBreachesStatusModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSlaBreachesStatusModel" }, "nullable": true } }, "additionalProperties": false }, "ReportSlaBreachesTimeModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "fr": { "type": "integer", "format": "int32" }, "nr": { "type": "integer", "format": "int32" }, "resolution": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportSlaBreachesTimeModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSlaBreachesTimeModel" }, "nullable": true } }, "additionalProperties": false }, "ReportSlaChatDetailModel": { "type": "object", "properties": { "chatId": { "type": "integer", "format": "int64" }, "logTime": { "type": "string", "format": "date-time", "nullable": true }, "company": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "visitorContactId": { "type": "string", "nullable": true }, "visitor": { "type": "string", "nullable": true }, "visitorName": { "type": "string", "nullable": true }, "visitorPhone": { "type": "string", "nullable": true }, "visitorEmail": { "type": "string", "nullable": true }, "agent": { "type": "integer", "format": "int64" }, "agentName": { "type": "string", "nullable": true }, "slaId": { "type": "integer", "format": "int64" }, "slaPolicyId": { "type": "integer", "format": "int64" }, "slaName": { "type": "string", "nullable": true }, "slaType": { "$ref": "#/components/schemas/SlaType" }, "slaExpectedDate": { "type": "string", "format": "date-time", "nullable": true }, "slaActualDate": { "type": "string", "format": "date-time", "nullable": true }, "slaViolationTimeSec": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReportSlaChatDetailModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSlaChatDetailModel" }, "nullable": true } }, "additionalProperties": false }, "ReportSlaTicketDetailModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "subject": { "type": "string", "nullable": true }, "pipelineId": { "type": "integer", "format": "int64" }, "stageId": { "type": "integer", "format": "int64" }, "orderNo": { "type": "integer", "format": "int32" }, "contactId": { "type": "integer", "format": "int64" }, "contactName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhone": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int64" }, "companyName": { "type": "string", "nullable": true }, "categoryIds": { "type": "string", "nullable": true }, "categoryNames": { "type": "string", "nullable": true }, "ownerIds": { "type": "string", "nullable": true }, "ownerNames": { "type": "string", "nullable": true }, "ownerPhotos": { "type": "string", "nullable": true }, "ownerColors": { "type": "string", "nullable": true }, "followerIds": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "$ref": "#/components/schemas/TicketSource" }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "priority": { "$ref": "#/components/schemas/PriorityType" }, "createdUserId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedUserId": { "type": "integer", "format": "int64" }, "updatedDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64" }, "linked": { "type": "string", "nullable": true }, "customFields": { "type": "string", "nullable": true }, "firstResponseDate": { "type": "string", "format": "date-time", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "resolveTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "resolveTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "frTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "frTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "openTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "openTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "pendingTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "pendingTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "isSpam": { "type": "integer", "format": "int32", "nullable": true }, "slaId": { "type": "integer", "format": "int64" }, "slaPolicyId": { "type": "integer", "format": "int64" }, "slaName": { "type": "string", "nullable": true }, "slaType": { "$ref": "#/components/schemas/SlaType" }, "slaExpectedDate": { "type": "string", "format": "date-time", "nullable": true }, "slaActualDate": { "type": "string", "format": "date-time", "nullable": true }, "slaViolationTimeSec": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ReportSlaTicketDetailModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSlaTicketDetailModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketCategoryPerformanceModel": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketCategoryPerformanceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketCategoryPerformanceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRDayModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRDayModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRDayModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRModel": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRMonthModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRMonthModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRMonthModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRPriorityModel": { "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/PriorityType" }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRPriorityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRPriorityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRSourceModel": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/TicketSource" }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRSourceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRSourceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRStageModel": { "type": "object", "properties": { "stage": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRStageModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRStageModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketFCRUserModel": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "totalCount": { "type": "integer", "format": "int32" }, "fcrCount": { "type": "integer", "format": "int32" }, "fcrPercentage": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketFCRUserModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketFCRUserModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketOverviewModel": { "type": "object", "properties": { "totalOpenedTickets": { "type": "integer", "format": "int32" }, "totalResolvedTickets": { "type": "integer", "format": "int32" }, "openTickets": { "type": "integer", "format": "int32" }, "avgResolutionSec": { "type": "integer", "format": "int32" }, "avgResolutionBusinessSec": { "type": "integer", "format": "int32" }, "avgFirstResponseSec": { "type": "integer", "format": "int32" }, "avgFirstResponseBusinessSec": { "type": "integer", "format": "int32" }, "frSla": { "type": "number", "format": "double" }, "nrSla": { "type": "number", "format": "double" }, "resolutionSla": { "type": "number", "format": "double" }, "slaTickets": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportTicketOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketPipelineModel": { "type": "object", "properties": { "pipelinesName": { "type": "string", "nullable": true }, "ticketsCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportTicketPipelineModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketPipelineModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketTimeEntryModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "agentId": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "ticketSubject": { "type": "string", "nullable": true }, "ticketStatus": { "$ref": "#/components/schemas/TicketStatus" }, "ticketPriority": { "$ref": "#/components/schemas/PriorityType" }, "agentName": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "timeSpent": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReportTicketTimeEntryModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketTimeEntryModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTicketTimeEntryTimeInfoModel": { "type": "object", "properties": { "totalTimeSpent": { "type": "integer", "format": "int64" }, "totalNonBillableTimeSpent": { "type": "integer", "format": "int64" }, "totalBillableTimeSpent": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ReportTicketUserPerformanceModel": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTicketUserPerformanceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTicketUserPerformanceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalCallLogTagsModel": { "type": "object", "properties": { "tag": { "type": "string", "nullable": true }, "incoming": { "type": "integer", "format": "int32" }, "outgoing": { "type": "integer", "format": "int32" }, "incomingMissed": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportTotalCallLogTagsModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalCallLogTagsModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalCallsModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "incoming": { "type": "integer", "format": "int32" }, "outgoing": { "type": "integer", "format": "int32" }, "incomingMissed": { "type": "integer", "format": "int32" }, "outgoingMissed": { "type": "integer", "format": "int32" }, "incomingTotal": { "type": "integer", "format": "int32" }, "outgoingTotal": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportTotalCallsModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalCallsModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalChatCityModel": { "type": "object", "properties": { "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportTotalChatCityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalChatCityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalChatModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "solved": { "type": "integer", "format": "int32" }, "totalResponseTime": { "type": "string", "nullable": true }, "totalTime": { "type": "string", "nullable": true }, "totalResponseTimeMin": { "type": "string", "nullable": true }, "totalTimeMin": { "type": "string", "nullable": true }, "totalTimeSec": { "type": "string", "nullable": true }, "avgTotalResponseTimeSec": { "type": "string", "nullable": true }, "avgtotalTimeSec": { "type": "string", "nullable": true }, "avgTotalResponseTime2": { "type": "string", "nullable": true }, "avgTotalTime2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalChatModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalChatModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalChatUserModel": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" }, "solved": { "type": "integer", "format": "int32" }, "totalResponseTime": { "type": "string", "nullable": true }, "totalTime": { "type": "string", "nullable": true }, "totalWorkTime": { "type": "string", "nullable": true }, "totalResponseTimeMin": { "type": "integer", "format": "int32" }, "totalTimeMin": { "type": "integer", "format": "int32" }, "totalWorkTimeMin": { "type": "integer", "format": "int32" }, "totalTimeSec": { "type": "integer", "format": "int32" }, "avgTotalResponseTimeSec": { "type": "integer", "format": "int32" }, "avgtotalTimeSec": { "type": "integer", "format": "int32" }, "avgTotalResponseTime2": { "type": "string", "nullable": true }, "avgTotalTime2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalChatUserModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalChatUserModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DealStatus" }, "total": { "type": "integer", "format": "int32" }, "totalValue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalDealsModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsSourceModel": { "type": "object", "properties": { "source": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/DealStatus" }, "total": { "type": "integer", "format": "int32" }, "totalValue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsSourceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalDealsSourceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsStageModel": { "type": "object", "properties": { "pipeline": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DealStatus" }, "total": { "type": "integer", "format": "int32" }, "totalValue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsStageModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalDealsStageModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsUserModel": { "type": "object", "properties": { "ownerName": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/DealStatus" }, "total": { "type": "integer", "format": "int32" }, "totalValue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportTotalDealsUserModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalDealsUserModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalTicketsModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTotalTicketsModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalTicketsModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalTicketsPriorityModel": { "type": "object", "properties": { "priority": { "$ref": "#/components/schemas/PriorityType" }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTotalTicketsPriorityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalTicketsPriorityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalTicketsSourceModel": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/TicketSource" }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTotalTicketsSourceModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalTicketsSourceModel" }, "nullable": true } }, "additionalProperties": false }, "ReportTotalTicketsStageModel": { "type": "object", "properties": { "pipeline": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "openTickets": { "type": "integer", "format": "int32" }, "resolvedTickets": { "type": "integer", "format": "int32" }, "totalMin": { "type": "number", "format": "double" }, "avgMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ReportTotalTicketsStageModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportTotalTicketsStageModel" }, "nullable": true } }, "additionalProperties": false }, "ReportUserActivityOverviewModel": { "type": "object", "properties": { "totalMinute": { "type": "integer", "format": "int32" }, "loginDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ReportUserActivityOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportUserActivityOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportUserGroupAvailabilityModel": { "type": "object", "properties": { "groupId": { "type": "integer", "format": "int64" }, "userCount": { "type": "integer", "format": "int64" }, "dealUnavailableCount": { "type": "integer", "format": "int64" }, "ticketUnavailableCount": { "type": "integer", "format": "int64" }, "chatUnavailableCount": { "type": "integer", "format": "int64" }, "callUnavailableCount": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "ReportUserGroupAvailabilityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportUserGroupAvailabilityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportUserTotalActivityModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "loginDate": { "type": "string", "format": "date-time" }, "logoutDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReportUserTotalActivityModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportUserTotalActivityModel" }, "nullable": true } }, "additionalProperties": false }, "ReportUserTotalStateModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" }, "state": { "$ref": "#/components/schemas/UserStateType" } }, "additionalProperties": false }, "ReportUserTotalStateModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportUserTotalStateModel" }, "nullable": true } }, "additionalProperties": false }, "ReportUserTotalStateOverviewModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "activeDuration": { "type": "integer", "format": "int32" }, "passiveDuration": { "type": "integer", "format": "int32" }, "breakDuration": { "type": "integer", "format": "int32" }, "meetingDuration": { "type": "integer", "format": "int32" }, "trainingDuration": { "type": "integer", "format": "int32" }, "middayBreakDuration": { "type": "integer", "format": "int32" }, "outboundCallDuration": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportUserTotalStateOverviewModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportUserTotalStateOverviewModel" }, "nullable": true } }, "additionalProperties": false }, "ReportVisibility": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "category": { "$ref": "#/components/schemas/ReportCategory" }, "name": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/VisibilityType" }, "visibleTo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportVisibilityResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/ReportVisibility" } }, "additionalProperties": false }, "ReportVisitorType": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "total": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReportWorkingLogModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "workingStartDate": { "type": "string", "format": "date-time" }, "workingEndDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ReportWorkingLogModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReportWorkingLogModel" }, "nullable": true } }, "additionalProperties": false }, "RequiredFieldsErrorResource": { "type": "object", "properties": { "missingFields": { "type": "array", "items": { "type": "string" }, "description": "Boş kalan zorunlu alanların fieldName listesi. Özel alanlar customFields anahtarına,\r\nsistem alanları ticket alanına karşılık gelir.", "nullable": true }, "success": { "type": "boolean", "default": false, "readOnly": true }, "errorCode": { "type": "integer", "description": "See Infoset.Types.ResultCode for all possible error codes", "format": "int32", "default": -1 }, "errorName": { "type": "string", "description": "See Infoset.Types.ResultCode for all possible error names", "nullable": true, "readOnly": true }, "message": { "type": "string", "description": "Error message", "nullable": true }, "details": { "description": "Optional machine-readable context for recoverable business errors.", "default": null, "nullable": true } }, "additionalProperties": false, "description": "IDT-1357: zorunlu alan kontrolüne takılan güncellemenin cevabı. İstemcinin hangi alanları\r\ndoldurması gerektiğini bilmesi gerektiği için düz Infoset.Types.Models.Resources.ErrorResource yetmiyor —\r\no yalnızca mesaj ve kod taşıyor." }, "ResultCode": { "enum": [ 0, -3282, -3281, -3280, -3279, -3278, -3277, -3276, -3275, -3274, -3273, -3272, -3271, -3270, -3269, -3268, -3267, -3266, -3265, -3264, -3263, -3262, -3261, -3260, -3259, -3258, -3257, -3256, -3255, -3254, -3253, -3252, -3251, -3250, -3249, -3248, -3247, -3246, -3245, -3244, -3243, -3242, -3241, -3240, -3239, -3238, -3237, -3236, -3235, -3234, -3233, -3232, -3231, -3230, -3229, -3228, -3227, -3226, -3225, -3224, -3223, -3222, -3221, -3220, -3219, -3218, -3217, -3216, -3215, -3214, -3213, -3212, -3211, -3210, -3202, -3201, -3200, -3121, -3120, -3119, -3118, -3117, -3116, -3115, -3114, -3113, -3112, -3111, -3110, -3109, -3108, -3107, -3106, -3105, -3104, -3103, -3102, -3101, -3012, -3011, -3010, -3009, -3008, -3007, -3006, -3005, -3004, -3003, -3001, -3000, -2954, -2953, -2952, -2951, -2950, -2912, -2911, -2910, -2909, -2908, -2907, -2905, -2904, -2903, -2902, -2901, -2900, -2849, -2848, -2847, -2846, -2845, -2844, -2843, -2842, -2841, -2840, -2839, -2838, -2837, -2836, -2835, -2834, -2833, -2832, -2831, -2830, -2829, -2828, -2827, -2826, -2825, -2824, -2823, -2822, -2821, -2820, -2819, -2818, -2817, -2816, -2815, -2814, -2813, -2812, -2811, -2810, -2802, -2801, -2800, -2702, -2701, -2700, -2699, -2698, -2697, -2696, -2695, -2694, -2693, -2692, -2691, -2690, -2681, -2680, -2670, -2660, -2650, -2640, -2630, -2620, -2611, -2610, -2602, -2601, -2600, -2500, -2400, -2300, -2201, -2200, -2100, -2002, -2001, -2000, -1951, -1950, -1930, -1926, -1925, -1924, -1923, -1922, -1921, -1920, -1919, -1918, -1917, -1916, -1915, -1914, -1913, -1912, -1911, -1910, -1909, -1908, -1907, -1906, -1905, -1904, -1903, -1902, -1901, -1900, -1803, -1802, -1801, -1203, -1202, -1201, -1200, -905, -822, -821, -820, -819, -818, -817, -816, -815, -814, -813, -812, -811, -421, -417, -416, -415, -413, -412, -411, -409, -408, -406, -405, -404, -403, -402, -401, -400, -340, -339, -338, -337, -336, -335, -334, -333, -332, -331, -329, -328, -327, -325, -324, -323, -322, -321, -320, -319, -318, -317, -316, -315, -314, -313, -312, -311, -309, -308, -302, -301, -214, -213, -212, -209, -202, -195, -194, -151, -97, -96, -95, -91, -90, -89, -88, -87, -86, -83, -82, -81, -80, -64, -63, -60, -23, -22, -21, -13, -12, -9, -8, -7, -4, -1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "RightRecord": { "type": "object", "properties": { "editRec": { "type": "integer", "format": "int32" }, "delRec": { "type": "integer", "format": "int32" }, "newRec": { "type": "integer", "format": "int32" }, "viewRec": { "type": "integer", "format": "int32" }, "exportRec": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RoomLastSuggestionDto": { "type": "object", "properties": { "text": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "sources": { "$ref": "#/components/schemas/CopilotSuggestionSources" }, "generatedAt": { "type": "string", "nullable": true }, "suggestionId": { "type": "integer", "description": "AI-side row id an agent's feedback attaches to; null when ungradable.", "format": "int64", "nullable": true }, "feedback": { "type": "string", "description": "The REQUESTING agent's own vote (`up` / `down`), or null when they have\r\nnot voted. Filled in by the controller, not by the snapshot proxy. Never another\r\nagent's — a colleague's rating would anchor this agent's judgement.", "nullable": true } }, "additionalProperties": false, "description": "The last persisted suggestion for a room (post-refresh render)." }, "RoomMetadataDto": { "type": "object", "properties": { "roomId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "accountName": { "type": "string", "nullable": true }, "contactId": { "type": "integer", "format": "int64" }, "channel": { "type": "string", "nullable": true }, "assignedAgentId": { "type": "integer", "format": "int64", "nullable": true }, "status": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "nullable": true }, "departmentName": { "type": "string", "nullable": true }, "assignedAgentType": { "type": "string", "nullable": true }, "chatBotId": { "type": "integer", "format": "int64" }, "widgetLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Room metadata response for `GET /api/chat/rooms/{roomId}`.\r\n`Status` is one of `\"open\"` | `\"closed\"`; `AssignedAgentId` is null when unassigned." }, "RoomStreamInFlightDto": { "type": "object", "properties": { "streamId": { "type": "string", "nullable": true }, "seq": { "type": "integer", "description": "Seq of the last event reflected in Infoset.Service.InternalApi.RoomStreamInFlightDto.TextSoFar.", "format": "int32" }, "stage": { "type": "string", "description": "`searching_kb` or `generating`.", "nullable": true }, "textSoFar": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "In-flight stream state for a room (mid-stream join bootstrap)." }, "RoomStreamSnapshotDto": { "type": "object", "properties": { "inFlight": { "$ref": "#/components/schemas/RoomStreamInFlightDto" }, "last": { "$ref": "#/components/schemas/RoomLastSuggestionDto" } }, "additionalProperties": false, "description": "The streaming-era snapshot for a chat room, served to the dashboard by\r\n`GET /v1/chat/rooms/{roomId}/suggestions`. Mirrors the copilot-service\r\ninternal response (`GET /internal/rooms/{roomId}/suggestions`).\r\nInfoset.Service.InternalApi.RoomStreamSnapshotDto.InFlight is the Redis stream accumulator (non-null while a\r\nsuggestion is streaming — the dashboard bootstraps the partial text from it\r\nand then applies live `copilotStreamEvent` pushes with a higher seq);\r\nInfoset.Service.InternalApi.RoomStreamSnapshotDto.Last is the most recent persisted suggestion. Both null means\r\nno suggestion yet (or the proxy failed open)." }, "RoomSuggestionsDto": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/CopilotSuggestionItem" }, "nullable": true }, "generatedAt": { "type": "string", "description": "ISO timestamp of when the snapshot was generated, or null when none.", "nullable": true } }, "additionalProperties": false, "description": "The copilot suggestion snapshot for a TICKET, as served to the dashboard by\r\n`GET /v1/tickets/{id}/suggestions`. Mirrors the copilot-service internal\r\nresponse (`GET /internal/tickets/{id}/suggestions`) — the ticket flow keeps\r\nthe fan-out era shape. An empty Infoset.Service.InternalApi.RoomSuggestionsDto.Suggestions list with a null\r\nInfoset.Service.InternalApi.RoomSuggestionsDto.GeneratedAt means no snapshot exists yet (or the proxy failed open)." }, "RoutingQueue": { "required": [ "departmentIds", "eventType", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "description": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "linkedType": { "type": "integer", "format": "int32" }, "eventType": { "maxLength": 32, "minLength": 1, "type": "string" }, "assignMethod": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "workingHourType": { "type": "integer", "format": "int32" }, "workingHourId": { "type": "integer", "format": "int64", "nullable": true }, "status": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueCondition" }, "nullable": true }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueAction" }, "nullable": true } }, "additionalProperties": false }, "RoutingQueueAction": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "queueId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "actionType": { "maxLength": 32, "type": "string", "nullable": true }, "groupId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "orderNo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RoutingQueueActionDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "actionType": { "type": "string", "nullable": true }, "groupId": { "type": "integer", "format": "int64" }, "groupName": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "userName": { "type": "string", "nullable": true }, "orderNo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RoutingQueueCondition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "queueId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "filterType": { "maxLength": 16, "type": "string", "nullable": true }, "filterColumn": { "maxLength": 64, "type": "string", "nullable": true }, "filterOperation": { "maxLength": 16, "type": "string", "nullable": true }, "filterValue": { "maxLength": 512, "type": "string", "nullable": true }, "filterLevel": { "type": "integer", "format": "int32" }, "filterLevelOperation": { "maxLength": 4, "type": "string", "nullable": true } }, "additionalProperties": false }, "RoutingQueueDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "departmentIds": { "type": "string", "nullable": true }, "linkedType": { "type": "integer", "format": "int32" }, "eventType": { "type": "string", "nullable": true }, "assignMethod": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "workingHourType": { "type": "integer", "format": "int32" }, "workingHourId": { "type": "integer", "format": "int64", "nullable": true }, "status": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueCondition" }, "nullable": true }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueActionDetail" }, "nullable": true } }, "additionalProperties": false }, "RoutingQueueGroupItem": { "type": "object", "properties": { "groupId": { "type": "integer", "format": "int64" }, "groupName": { "type": "string", "nullable": true }, "orderNo": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RoutingQueueListItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "departmentIds": { "type": "string", "nullable": true }, "linkedType": { "type": "integer", "format": "int32" }, "eventType": { "type": "string", "nullable": true }, "assignMethod": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueGroupItem" }, "nullable": true } }, "additionalProperties": false }, "RoutingQueueListItemQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingQueueListItem" }, "nullable": true } }, "additionalProperties": false }, "RoutingRunLog": { "required": [ "runId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "runId": { "maxLength": 64, "minLength": 1, "type": "string" }, "queueId": { "type": "integer", "format": "int64" }, "queueName": { "maxLength": 255, "type": "string", "nullable": true }, "linkedId": { "type": "integer", "format": "int64" }, "linkedType": { "type": "integer", "format": "int32" }, "step": { "$ref": "#/components/schemas/RoutingRunStep" }, "userId": { "type": "integer", "format": "int64", "nullable": true }, "groupId": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "RoutingRunLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingRunLog" }, "nullable": true } }, "additionalProperties": false }, "RoutingRunStep": { "enum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "SaveUserAvailabilityModel": { "type": "object", "properties": { "status": { "type": "integer", "description": "0 = Passive, 1 = Active", "format": "int32" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "departmentIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SavedFilter": { "required": [ "departmentIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/SavedFilterVisibility" }, "visibleTo": { "type": "string", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "filter": { "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "count": { "type": "integer", "format": "int32", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "SavedFilterResponse": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "nullable": true }, "success": { "type": "boolean", "readOnly": true }, "message": { "type": "string", "nullable": true }, "resource": { "$ref": "#/components/schemas/SavedFilter" } }, "additionalProperties": false }, "SavedFilterVisibility": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "SavedReply": { "required": [ "departmentIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "msg": { "maxLength": 10000, "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "SavedReplyQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SavedReply" }, "nullable": true } }, "additionalProperties": false }, "SearchType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "SipServer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "serverId": { "type": "integer", "format": "int64" }, "serverName": { "type": "string", "nullable": true }, "queueName": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "maxChannels": { "type": "integer", "format": "int64" }, "currentChannels": { "type": "integer", "format": "int64" }, "httpBaseUrl": { "type": "string", "nullable": true }, "httpPort": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SipServerQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SipServer" }, "nullable": true } }, "additionalProperties": false }, "SipServerUpsertRequest": { "required": [ "queueName", "serverName" ], "type": "object", "properties": { "serverId": { "type": "integer", "description": "Business key (sip_servers.server_id). On POST, if null the service assigns MAX(server_id)+1;\r\nadmin may override to a specific value. On PUT the URL path param takes precedence.", "format": "int64", "nullable": true }, "serverName": { "maxLength": 128, "minLength": 1, "type": "string" }, "queueName": { "maxLength": 128, "minLength": 1, "type": "string" }, "ipAddress": { "maxLength": 128, "type": "string", "nullable": true }, "httpBaseUrl": { "maxLength": 256, "pattern": "^$|^https?://.+", "type": "string", "description": "HTTP base URL for CallServer API (e.g. \"http://10.87.31.214:8080\"). Used by CSD-* HTTP decoupling.", "nullable": true }, "httpPort": { "maximum": 65535, "minimum": 1, "type": "integer", "format": "int32" }, "maxChannels": { "maximum": 10000, "minimum": 1, "type": "integer", "format": "int64" }, "status": { "pattern": "^(AVAILABLE|BUSY|OFFLINE|MAINTENANCE)$", "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false, "description": "Create/update payload for /v1/sip-servers endpoints." }, "SlaBreach": { "required": [ "linkedId", "linkedType", "slaType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "description": "IDT-435: brand of the parent record (tasks/chat_rooms). 0 = legacy/brand-less.", "format": "int64" }, "linkedType": { "type": "integer", "description": "", "format": "int32" }, "linkedId": { "type": "integer", "description": "", "format": "int64" }, "slaType": { "$ref": "#/components/schemas/SlaType" }, "expectedDate": { "type": "string", "description": "fr, nr, closed.. olması gereken zaman", "format": "date-time", "nullable": true }, "actualDate": { "type": "string", "description": "işlem zamanı", "format": "date-time", "nullable": true }, "slaPolicyId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "SlaBreachQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SlaBreach" }, "nullable": true } }, "additionalProperties": false }, "SlaPolicy": { "required": [ "slaPolicyData", "slaPolicyFilters", "slaPolicyMetrics" ], "type": "object", "properties": { "slaPolicyData": { "$ref": "#/components/schemas/SlaPolicyData" }, "slaPolicyFilters": { "type": "array", "items": { "$ref": "#/components/schemas/SlaPolicyFilter" } }, "slaPolicyMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/SlaPolicyMetric" } } }, "additionalProperties": false }, "SlaPolicyData": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentIds": { "maxLength": 512, "type": "string", "description": "IDT-435: comma-separated department (brand) ids this policy applies to (Kategori 1 — multi-brand).\r\nEmpty only for legacy accounts without departments; matching treats empty as \"applies to all\".", "nullable": true }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "description": { "maxLength": 255, "type": "string", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "SlaPolicyDataQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SlaPolicyData" }, "nullable": true } }, "additionalProperties": false }, "SlaPolicyFilter": { "required": [ "filterLevelOperation", "filterOperation", "filterPrefix" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "slaId": { "type": "integer", "format": "int64" }, "filterType": { "type": "string", "description": "\"condition\" or \"event\"", "nullable": true }, "filterColumn": { "type": "string", "nullable": true }, "filterPrefix": { "$ref": "#/components/schemas/QueryPrefix" }, "filterValue": { "type": "string", "nullable": true }, "filterOperation": { "$ref": "#/components/schemas/QueryOperator" }, "filterLevel": { "type": "integer", "format": "int32" }, "filterLevelOperation": { "$ref": "#/components/schemas/QueryOperator" }, "requirePresenceInDiff": { "type": "boolean" } }, "additionalProperties": false }, "SlaPolicyMetric": { "required": [ "slaId", "target", "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "slaId": { "type": "integer", "format": "int64" }, "type": { "$ref": "#/components/schemas/SlaType" }, "priorityLevel": { "$ref": "#/components/schemas/PriorityType" }, "workingHourType": { "$ref": "#/components/schemas/WorkingHourType" }, "target": { "minimum": 0, "type": "number", "description": "Target SLA time in minutes", "format": "double" }, "escalate": { "type": "boolean", "description": "Whether to notify others if target is not achieved" }, "userIds": { "maxLength": 255, "type": "string", "description": "Users to notify if target is not achieved", "nullable": true } }, "additionalProperties": false }, "SlaStats": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "description": "IDT-435: brand of the parent record (tasks/chat_rooms) at the time the SLA was applied.\r\n0 = legacy/brand-less.", "format": "int64" }, "slaId": { "type": "integer", "format": "int64" }, "linkedType": { "type": "integer", "format": "int32" }, "linkedId": { "type": "integer", "format": "int64" }, "dueBy": { "type": "string", "description": "Çözülmesi gereken zaman", "format": "date-time", "nullable": true }, "resolveTime": { "type": "string", "description": "Çözülme Zamanı", "format": "date-time", "nullable": true }, "dueEscalated": { "type": "boolean" }, "frDueBy": { "type": "string", "description": "İlk cevaplanması gereken zaman", "format": "date-time", "nullable": true }, "frTime": { "type": "string", "description": "İlk cevaplanma zamanı", "format": "date-time", "nullable": true }, "frEscalated": { "type": "boolean", "description": "İlk cevapmala için e-posta bildirimi yapıldı mı?" }, "nrDueBy": { "type": "string", "description": "Sonraki cevaplanması gereken zaman", "format": "date-time", "nullable": true }, "nrTime": { "type": "string", "description": "Sonraki cevap zamanı", "format": "date-time", "nullable": true }, "nrEscalated": { "type": "boolean", "description": "Sonraki cevaplanma için e-posta bildirimi yapıldı mı?" }, "accountId": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "readOnly": true }, "SlaType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "SmsLog": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "createdUserId": { "type": "integer", "format": "int64" }, "messageBody": { "type": "string", "nullable": true }, "numbers": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "timerId": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "integrationType": { "type": "string", "nullable": true }, "linkedType": { "type": "integer", "description": "Linked type of the incoming SMS, could be deal or ticket for example\r\nif null, the SMS will not appear in any of the task/deal logs\r\nit will appear only in the contact activities.", "format": "int32", "nullable": true }, "linkedId": { "type": "integer", "description": "Linked item id", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SmsLogQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SmsLog" }, "nullable": true } }, "additionalProperties": false }, "Stage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "pipelineId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 60, "type": "string", "nullable": true }, "orderNo": { "type": "integer", "format": "int32" }, "departmentIds": { "maxLength": 512, "type": "string", "nullable": true }, "status": { "maxLength": 1, "type": "string", "description": "'A': Active, 'P': Passive", "nullable": true } }, "additionalProperties": false }, "StageQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Stage" }, "nullable": true } }, "additionalProperties": false }, "SuggestionFeedbackRequestDto": { "type": "object", "properties": { "rating": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "An agent's verdict on one AI suggestion. `Rating` is `up`, `down`, or\r\n`none` to withdraw an earlier vote — a withdrawal is the same operation from the\r\nclient's side, which keeps the card to a single call site.\r\nThe voter is NOT in the body: it is the authenticated session's user. That matters more\r\nthan usual here, because the consumer trusts the event's agentId and a topic carries no\r\nper-message authentication to check it against." }, "Survey": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "message": { "maxLength": 10000, "type": "string", "nullable": true }, "linkedId": { "type": "integer", "format": "int64" }, "linkedTable": { "$ref": "#/components/schemas/Table" }, "type": { "$ref": "#/components/schemas/SurveyType" }, "inputType": { "$ref": "#/components/schemas/SurveyInputType" }, "options": { "maxLength": 10000, "type": "string", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyLink" }, "nullable": true } }, "additionalProperties": false }, "SurveyInputType": { "enum": [ 1, 2 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "SurveyLink": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "linkedId": { "type": "integer", "format": "int64" }, "linkedTable": { "$ref": "#/components/schemas/Table" } }, "additionalProperties": false }, "SurveyResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/SurveyType" }, "inputType": { "$ref": "#/components/schemas/SurveyInputType" }, "options": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SurveyResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResponseModel" }, "nullable": true } }, "additionalProperties": false }, "SurveyType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "Table": { "enum": [ 0, 1, 2, 5, 6, 7, 10, 11, 12, 13, 14, 15, 16, 19, 20, 21, 22, 23, 25, 26, 27, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 52, 53, 55, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 72 ], "type": "integer", "description": "Infoset data objects

Enum values:

", "format": "int32" }, "TagResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentIds": { "type": "string", "nullable": true }, "rootId": { "type": "integer", "format": "int64" }, "systemTag": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "assignedUserIds": { "type": "string", "description": "assigned user id list [..,n]", "nullable": true }, "assignedUsers": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TagResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TagResponseModel" }, "nullable": true } }, "additionalProperties": false }, "TemplateModel": { "required": [ "departmentIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "name": { "maxLength": 100, "type": "string", "nullable": true }, "description": { "maxLength": 1000, "type": "string", "nullable": true }, "template": { "maxLength": 10000, "type": "string", "nullable": true }, "pipelineIds": { "maxLength": 64, "type": "string", "nullable": true }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "TemplateModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateModel" }, "nullable": true } }, "additionalProperties": false }, "Ticket": { "required": [ "orderNo", "pipelineId", "priority", "source", "stageId", "status", "subject" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "description": "Department (brand) this ticket belongs to. Derived from the pipeline on create (IDT-417).", "format": "int64" }, "subject": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Ticket's subject", "example": "Example ticket" }, "contactId": { "type": "integer", "description": "ID of the related contact", "format": "int64" }, "companyId": { "type": "integer", "description": "ID of the related company", "format": "int64", "nullable": true }, "categoryIds": { "maxLength": 128, "type": "string", "description": "Category IDs separated by commas", "nullable": true }, "ownerIds": { "maxLength": 128, "type": "string", "description": "IDs of the users assigned to this ticket, separated by commas", "default": null, "nullable": true }, "ownerGroupId": { "type": "integer", "description": "IDs of the group assigned to this ticket", "format": "int64", "nullable": true }, "followerIds": { "maxLength": 128, "type": "string", "description": "IDs of the users following this ticket, separated by commas", "default": null, "nullable": true }, "createdContactId": { "type": "integer", "format": "int64", "writeOnly": true }, "createdAutomationId": { "type": "integer", "format": "int64", "writeOnly": true }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "startDate": { "type": "string", "description": "Start date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true }, "dueDate": { "type": "string", "description": "Due date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true }, "firstResponseDate": { "type": "string", "description": "First response date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true, "readOnly": true }, "closingDate": { "type": "string", "description": "Closing date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "default": null, "nullable": true, "readOnly": true }, "reopenDate": { "type": "string", "format": "date-time", "default": null, "nullable": true, "readOnly": true }, "source": { "$ref": "#/components/schemas/TicketSource" }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "lastStatusChangeDate": { "type": "string", "format": "date-time", "default": null, "nullable": true }, "priority": { "$ref": "#/components/schemas/PriorityType" }, "notes": { "maxLength": 10000, "type": "string", "default": "", "nullable": true }, "pipelineId": { "type": "integer", "description": "ID of the pipeline that this ticket belongs to", "format": "int64" }, "stageId": { "type": "integer", "description": "ID of the stage that this ticket belongs to", "format": "int64" }, "orderNo": { "type": "integer", "description": "Kanban stage order", "format": "int32", "example": 0 }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "description": "Linked item ID", "format": "int64", "writeOnly": true }, "customFields": { "maxLength": 4096, "type": "string", "description": "A stringified JSON object mapping custom field names to values\r\n \r\nExample: {\"My Text Custom Field\":\"Field Value\",\"My Numeric Custom Field\":2}", "default": null, "nullable": true }, "isSpam": { "type": "integer", "description": "1 if the ticket is a spam, 0 (or null) otherwise", "format": "int32", "default": null, "nullable": true }, "mergeTickets": { "type": "array", "items": { "$ref": "#/components/schemas/MergedTicketLink" }, "description": "Tickets to be merged to this root ticket", "default": null, "nullable": true, "writeOnly": true }, "slaId": { "type": "integer", "description": "If an SLA policy affects this ticket, ID of the attached SlaStats, otherwise null", "format": "int64", "nullable": true }, "mergeId": { "type": "integer", "description": "If this ticket is merged with another ticket, ID of the root ticket, otherwise null", "format": "int64", "nullable": true }, "nextSlaBreach": { "type": "string", "description": "Next SLA breach date in UTC (yyyy-MM-dd HH:mm:ss)", "format": "date-time", "nullable": true, "readOnly": true }, "slaStats": { "$ref": "#/components/schemas/SlaStats" }, "resolveTimeSec": { "type": "integer", "description": "Resolve time in seconds", "format": "int32", "nullable": true, "readOnly": true }, "resolveTimeBusinessSec": { "type": "integer", "description": "Resolve time in seconds (calculated in business hours)", "format": "int32", "nullable": true, "readOnly": true }, "frTimeSec": { "type": "integer", "description": "First response time in seconds", "format": "int32", "nullable": true, "readOnly": true }, "frTimeBusinessSec": { "type": "integer", "description": "First response time in seconds (calculated in business hours)", "format": "int32", "nullable": true, "readOnly": true }, "openTimeSec": { "type": "integer", "description": "The time ticket stayed in Open status", "format": "int32", "nullable": true, "readOnly": true }, "openTimeBusinessSec": { "type": "integer", "description": "The time ticket stayed in Open status (calculated in business hours)", "format": "int32", "nullable": true, "readOnly": true }, "pendingTimeSec": { "type": "integer", "description": "The time ticket stayed in Pending status", "format": "int32", "nullable": true, "readOnly": true }, "pendingTimeBusinessSec": { "type": "integer", "description": "The time ticket stayed in Pending status (calculated in business hours)", "format": "int32", "nullable": true, "readOnly": true }, "firstAssignTimeSec": { "type": "integer", "description": "First assign time in seconds", "format": "int32", "nullable": true, "readOnly": true }, "chatTags": { "type": "string", "nullable": true }, "callTags": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TicketBriefDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "ageDays": { "type": "integer", "format": "int32" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Brief summary of the most recent ticket, including its status." }, "TicketCategoryFRTModel": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TicketCategoryFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketCategoryFRTModel" }, "nullable": true } }, "additionalProperties": false }, "TicketCustomerContextResponse": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "recommendation": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Dashboard-facing customer-context payload for a ticket, returned by\r\n`GET /v1/tickets/{id}/customer-context`. Ticket analog of the chat\r\ncustomer-context response — the lean shape ({ summary, recommendation }), distinct\r\nfrom the richer Infoset.Service.Hubs.Ticket.Service.TicketCustomerContext read row." }, "TicketDailyFRTModel": { "type": "object", "properties": { "forDate": { "type": "string", "nullable": true }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TicketDailyFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketDailyFRTModel" }, "nullable": true } }, "additionalProperties": false }, "TicketIntentResponse": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "One detected intent of a ticket, as returned by `GET /v1/tickets/{id}/intents`.\r\nTicket analog of the chat intent response, projecting the persisted\r\nInfoset.Service.Hubs.Ticket.Service.TicketIntent row down to the dashboard-facing fields." }, "TicketLog": { "required": [ "status", "ticketId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "pipelineId": { "type": "integer", "format": "int64" }, "stageId": { "type": "integer", "format": "int64" }, "notes": { "type": "string", "nullable": true }, "isPrivate": { "type": "integer", "description": "Whether it's a private note (visible to team members) or public note (visible to both contact and team members)", "format": "int32" }, "callLogId": { "type": "integer", "format": "int64", "nullable": true }, "chatId": { "type": "integer", "format": "int64", "nullable": true }, "emailId": { "type": "integer", "format": "int64", "nullable": true }, "smsLogId": { "type": "integer", "format": "int64", "nullable": true }, "contactId": { "type": "integer", "description": "ID of the contact that created this log", "format": "int64", "nullable": true }, "automationId": { "type": "integer", "description": "ID of the automation that created this log", "format": "int64", "nullable": true }, "pinDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "$ref": "#/components/schemas/DealTicketLogMetadata" }, "createdDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "TicketLogResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "pipelineId": { "type": "integer", "format": "int64" }, "stageId": { "type": "integer", "format": "int64" }, "createdUserId": { "type": "integer", "format": "int64" }, "createdContactId": { "type": "integer", "format": "int64" }, "createdAutomationId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "nullable": true }, "reactions": { "type": "array", "items": { "$ref": "#/components/schemas/UserReactionResponseModel" }, "nullable": true }, "isPrivate": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "callLogId": { "type": "integer", "format": "int64" }, "chatRoomId": { "type": "integer", "format": "int64" }, "chatId": { "type": "integer", "format": "int64" }, "emailId": { "type": "integer", "format": "int64" }, "emailFileNames": { "type": "string", "nullable": true }, "emailFileLinks": { "type": "string", "nullable": true }, "emailFileSizes": { "type": "string", "nullable": true }, "smsLogId": { "type": "integer", "format": "int64" }, "pinDate": { "type": "string", "format": "date-time", "nullable": true }, "metadata": { "$ref": "#/components/schemas/DealTicketLogMetadata" } }, "additionalProperties": false }, "TicketLogResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketLogResponseModel" }, "nullable": true } }, "additionalProperties": false }, "TicketResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "nullable": true }, "subject": { "type": "string", "nullable": true }, "departmentId": { "type": "integer", "format": "int64", "nullable": true }, "pipelineId": { "type": "integer", "format": "int64", "nullable": true }, "stageId": { "type": "integer", "format": "int64", "nullable": true }, "orderNo": { "type": "integer", "format": "int32", "nullable": true }, "contactId": { "type": "integer", "format": "int64", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "contactPhone": { "type": "string", "nullable": true }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "categoryIds": { "type": "string", "nullable": true }, "categoryNames": { "type": "string", "nullable": true }, "ownerIds": { "type": "string", "nullable": true }, "ownerGroupId": { "type": "integer", "format": "int64", "nullable": true }, "ownerNames": { "type": "string", "nullable": true }, "ownerPhotos": { "type": "string", "nullable": true }, "ownerColors": { "type": "string", "nullable": true }, "followerIds": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "$ref": "#/components/schemas/TicketSource" }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "lastStatusChangeDate": { "type": "string", "format": "date-time", "nullable": true }, "priority": { "$ref": "#/components/schemas/PriorityType" }, "createdUserId": { "type": "integer", "format": "int64", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedUserId": { "type": "integer", "format": "int64", "nullable": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true }, "linked": { "type": "string", "nullable": true }, "customFields": { "type": "string", "nullable": true }, "firstResponseDate": { "type": "string", "format": "date-time", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "reopenDate": { "type": "string", "format": "date-time", "nullable": true }, "resolveTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "resolveTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "frTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "frTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "openTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "openTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "pendingTimeSec": { "type": "integer", "format": "int32", "nullable": true }, "pendingTimeBusinessSec": { "type": "integer", "format": "int32", "nullable": true }, "isSpam": { "type": "integer", "format": "int32", "nullable": true }, "slaId": { "type": "integer", "format": "int64", "nullable": true }, "nextSlaBreach": { "type": "string", "format": "date-time", "nullable": true }, "slaStats": { "$ref": "#/components/schemas/SlaStats" }, "highlights": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "TicketResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketResponseModel" }, "nullable": true } }, "additionalProperties": false }, "TicketSentimentResponse": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "confidence": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "Dashboard-facing sentiment payload for a ticket, returned by\r\n`GET /v1/tickets/{id}/sentiment`. Ticket analog of the chat sentiment response —\r\nthe lean shape exposed to the API ({ category, confidence }), distinct from the richer\r\nInfoset.Service.Hubs.Ticket.Service.TicketSentimentResult read row." }, "TicketSource": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "TicketSourceFRTModel": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/TicketSource" }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TicketSourceFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSourceFRTModel" }, "nullable": true } }, "additionalProperties": false }, "TicketStageFRTModel": { "type": "object", "properties": { "pipeline": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TicketStageFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketStageFRTModel" }, "nullable": true } }, "additionalProperties": false }, "TicketStatus": { "enum": [ 1, 2, 3, 4 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "TicketSummaryRefreshResponse": { "type": "object", "properties": { "queued": { "type": "boolean" }, "cooldownSeconds": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Response of `POST /v1/tickets/{id}/summary/refresh`. Frozen wire contract:\r\n`{ queued: true }` when the request was enqueued, or\r\n`{ queued: false, cooldownSeconds: N }` while the per-ticket 30s cooldown holds —\r\nInfoset.Service.Hubs.Ticket.Service.TicketSummaryRefreshResponse.CooldownSeconds is therefore null-suppressed on the queued path." }, "TicketSummaryResponse": { "type": "object", "properties": { "summary": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Dashboard-facing summary payload for a ticket, returned by\r\n`GET /v1/tickets/{id}/summary`. The lean shape exposed to the API\r\n({ summary, updatedAt }), distinct from the Infoset.Service.Hubs.Ticket.Service.TicketSummaryResult read row." }, "TicketThreadDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "departmentName": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/TicketThreadMessageDto" }, "nullable": true } }, "additionalProperties": false, "description": "Ticket conversation thread response for\r\n`GET /api/copilot/tickets/{ticketId}/thread?accountId=`, consumed by the AI\r\nsummary-service. Messages are ordered oldest-first; the first message is the ticket\r\ncreation body. Ticket analog of Infoset.Types.Models.InternalApi.ConversationThreadDto." }, "TicketThreadMessageDto": { "type": "object", "properties": { "author": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true }, "at": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "One message of a ticket thread. `Author` is the frozen wire enum\r\n`\"customer\"` | `\"agent\"`; `At` is an ISO 8601 UTC timestamp string." }, "TicketUserFRTModel": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "avgFirstResponseMin": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TicketUserFRTModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TicketUserFRTModel" }, "nullable": true } }, "additionalProperties": false }, "TimeEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true }, "agentId": { "type": "integer", "format": "int64" }, "billable": { "type": "integer", "format": "int32" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "startTime": { "type": "string", "format": "date-time" }, "timerRunning": { "type": "integer", "format": "int32", "nullable": true }, "timeSpent": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "executedAt": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TimeEntryCreateModel": { "required": [ "executedAt", "startTime", "timerRunning", "timeSpent" ], "type": "object", "properties": { "agentId": { "type": "integer", "format": "int64" }, "timerRunning": { "type": "integer", "format": "int32" }, "timeSpent": { "type": "integer", "format": "int64" }, "startTime": { "type": "string", "format": "date-time" }, "executedAt": { "type": "string", "format": "date-time" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "note": { "maxLength": 1000, "type": "string", "nullable": true } }, "additionalProperties": false }, "TimeEntryResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "note": { "type": "string", "nullable": true }, "agentId": { "type": "integer", "format": "int64" }, "billable": { "type": "integer", "format": "int32" }, "companyId": { "type": "integer", "format": "int64", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executedAt": { "type": "string", "format": "date-time", "nullable": true }, "startTime": { "type": "string", "format": "date-time" }, "timerRunning": { "type": "integer", "format": "int32" }, "timeSpent": { "type": "integer", "format": "int64" }, "ticketId": { "type": "integer", "format": "int64" }, "totalTimeSpent": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "TimeEntryResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryResponseModel" }, "nullable": true } }, "additionalProperties": false }, "Timezone": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "gmt": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TimezoneQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Timezone" }, "nullable": true } }, "additionalProperties": false }, "Todo": { "required": [ "isFinished", "isPersonal", "ownerIds" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "readOnly": true }, "departmentId": { "type": "integer", "format": "int64", "readOnly": true }, "linkedType": { "$ref": "#/components/schemas/Table" }, "linkedId": { "type": "integer", "format": "int64", "nullable": true }, "linkedTo": { "type": "string", "nullable": true, "readOnly": true }, "reminderType": { "$ref": "#/components/schemas/ReminderType" }, "reminderDate": { "type": "string", "format": "date-time", "nullable": true }, "isFinished": { "type": "boolean" }, "isPersonal": { "type": "boolean" }, "ownerIds": { "maxLength": 1000, "minLength": 1, "type": "string", "description": "Comma-separated user ids" }, "notes": { "maxLength": 10000, "type": "string", "nullable": true }, "isNotified": { "type": "boolean", "description": "Is user notified on dashboard" }, "isEmailSent": { "type": "boolean", "description": "Is notification email sent" }, "accountId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "TodoQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Todo" }, "nullable": true } }, "additionalProperties": false }, "TokenRequestModel": { "required": [ "email", "password", "remember" ], "type": "object", "properties": { "email": { "maxLength": 100, "minLength": 1, "type": "string", "description": "User email", "format": "email" }, "password": { "maxLength": 100, "minLength": 1, "type": "string", "description": "User password" }, "remember": { "type": "boolean", "description": "If true, the generated token will be valid for 30 days, otherwise it'll be valid for 1 day", "default": false } }, "additionalProperties": false }, "TokenRequestModelMfa": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 100, "minLength": 1, "type": "string", "description": "User email", "format": "email" } }, "additionalProperties": false }, "ToneDto": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "ageDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false, "description": "The contact's recent tone, with the age of the observation in days." }, "UpdateChatMessageModel": { "type": "object", "properties": { "content": { "type": "string", "nullable": true }, "translatedContent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCopilotConfigDto": { "required": [ "enabled", "maxResponseTokens", "modelTemperature" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "modelTemperature": { "maximum": 1.0, "minimum": 0.0, "type": "number", "format": "double" }, "maxResponseTokens": { "maximum": 2000, "minimum": 100, "type": "integer", "format": "int32" }, "customSystemPrompt": { "maxLength": 4000, "type": "string", "nullable": true }, "departmentId": { "type": "integer", "description": "Brand (Infoset department id) this config row targets. 0 (default) = account-level\r\nrow; > 0 = a department-scoped row, validated against the caller's brand access on\r\nPUT. Not a DataAnnotation range because 0 is a valid \"account-level\" value.", "format": "int64" }, "selectedDeskIds": { "type": "array", "items": { "type": "string" }, "description": "Desk ids this config applies to. `null` = all desks (no restriction);\r\nempty = no desks; non-empty = the explicit desk ids. When non-null and non-empty\r\nthe controller validates every id exists on the account (and, for a department-scoped\r\nrow, belongs to that department) before the upsert.", "nullable": true } }, "additionalProperties": false, "description": "Write-side DTO for the AI Copilot tenant configuration (IDT-788). Posted by the\r\nadmin Settings → AI page via PUT `/v1/admin/copilot/config`. Controller\r\nvalidates via DataAnnotations; service layer performs the upsert.\r\n \r\nRanges:\r\n- Infoset.Types.Models.Admin.UpdateCopilotConfigDto.ModelTemperature: 0.0 (deterministic) → 1.0 (high creativity).\r\n- Infoset.Types.Models.Admin.UpdateCopilotConfigDto.MaxResponseTokens: 100 → 2000 — clamped to keep latency / cost\r\n bounded; raise the upper bound only with a product decision.\r\n- Infoset.Types.Models.Admin.UpdateCopilotConfigDto.CustomSystemPrompt: optional override appended to the base prompt.\r\n Empty string is allowed and treated as \"no override\"." }, "UpdateGenAiConfigDto": { "required": [ "enabled" ], "type": "object", "properties": { "departmentId": { "minimum": 1, "type": "integer", "description": "Brand this configuration targets. Mandatory and > 0: there is no account-level gen-ai\r\nrow, so a payload without a brand has no valid target.", "format": "int64" }, "enabled": { "type": "boolean" }, "maxResponseTokens": { "maximum": 2000, "minimum": 100, "type": "integer", "format": "int32", "nullable": true }, "idleWarningMinutes": { "maximum": 1440, "minimum": 1, "type": "integer", "description": "Minutes of complete silence before the agent asks the visitor whether they are still there.\r\nNull inherits the service default, like every tuning field here.\r\n \r\nThe lower bound is 1 and not 0: zero would mean \"warn immediately\", which in a live chat is\r\nthe assistant interrupting its own answer. Switching the behaviour off is not expressed as\r\na zero here — see the remarks on Infoset.Types.Models.Admin.UpdateGenAiConfigDto.IdleCloseMinutes.", "format": "int32", "nullable": true }, "idleCloseMinutes": { "maximum": 1440, "minimum": 1, "type": "integer", "description": "Further minutes of silence after the warning before the conversation is closed as solved.\r\n \r\nThe 1440-minute (24 h) ceiling is not arbitrary: a room the agent still holds is a room no\r\nhuman is looking at, so an unbounded value would let conversations accumulate forever in a\r\nstate where nobody is responsible for them.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Write DTO for the gen-ai interactive support agent configuration, posted by the admin\r\nsettings card via `PUT /v1/admin/genai/config`.\r\n \r\nIt mirrors Infoset.Types.Models.Admin.GenAiConfigDto minus everything the server owns:\r\n`AccountId` — comes from the JWT, never from the body.`AiBotId` — the identity pointer, written only by the bot seeder. Absent here so\r\n a client cannot re-point a brand's AI identity, and so an unrelated save preserves\r\n it instead of nulling it.`SelectedDeskIds` — resolved from the brand's copilot row; knowledge-base scope\r\n has exactly one owner and this is not it.\r\n \r\nThe one tuning field is nullable, and null means \"inherit the brand's copilot row\" rather than\r\nzero. That is what lets a brand be saved without pinning today's defaults into its row forever,\r\nand — because the upsert writes it straight through — what lets an override be cleared back\r\nto inherited by posting null.\r\n`[Range]` is skipped when the value is null, so \"null means inherit\" and the bounds\r\ncheck coexist — do not add a manual null check, it would defeat exactly that." }, "User": { "required": [ "displayName", "email", "password" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "departmentIds": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "email": { "maxLength": 100, "minLength": 1, "type": "string", "format": "email" }, "personalMailAccountId": { "type": "integer", "format": "int64", "nullable": true }, "displayName": { "maxLength": 128, "minLength": 1, "type": "string" }, "nickname": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "password": { "maxLength": 32, "minLength": 1, "type": "string" }, "loginType": { "enum": [ "AA==" ], "type": "byte", "description": "

Enum values:

" }, "active": { "type": "integer", "description": "0: Not active, 1:Active", "format": "int32" }, "ipAddress": { "type": "string", "nullable": true }, "gsmNumber": { "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 20, "type": "string", "nullable": true }, "status": { "type": "string" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "lastActivityDate": { "type": "string", "format": "date-time", "nullable": true }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "userNotificationSettings": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotifySetting" }, "nullable": true }, "timeZone": { "$ref": "#/components/schemas/Timezone" }, "accountPlan": { "$ref": "#/components/schemas/AccountPlan" }, "groupIds": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionsRecord" }, "nullable": true }, "isAdmin": { "type": "boolean" }, "expoPushToken": { "type": "string", "description": "Expo push notification Token", "nullable": true }, "isFirstLogin": { "type": "integer", "description": ">1 İlk login değil", "format": "int32" }, "autoTicketMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "passwordChangedDate": { "type": "string", "format": "date-time", "nullable": true }, "previousPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserAutoAssignLimits": { "type": "object", "properties": { "id": { "type": "integer", "description": "User ID", "format": "int64" }, "autoTicketMaxAssign": { "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "type": "integer", "format": "int32" }, "groupIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserAvailability": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "description": "0 = Passive, 1 = Active", "format": "int32" }, "linkedType": { "$ref": "#/components/schemas/Table" }, "departmentIds": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserAvailabilityOverviewResponseModel": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string", "nullable": true }, "state": { "type": "integer", "format": "int32" }, "callAvailability": { "type": "boolean" }, "dealAvailability": { "type": "boolean" }, "ticketAvailability": { "type": "boolean" }, "chatAvailability": { "type": "boolean" }, "startTime": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserAvailabilityOverviewResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserAvailabilityOverviewResponseModel" }, "nullable": true } }, "additionalProperties": false }, "UserAvailabilityQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserAvailability" }, "nullable": true } }, "additionalProperties": false }, "UserGroup": { "required": [ "departmentIds", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "autoTicketMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "notifyAdmins": { "type": "boolean" }, "departmentIds": { "maxLength": 512, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "UserGroupQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, "nullable": true } }, "additionalProperties": false }, "UserGroupUser": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "email": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "nickname": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "loginType": { "enum": [ "AA==" ], "type": "byte", "description": "

Enum values:

" }, "active": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string", "nullable": true }, "gsmNumber": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "status": { "type": "string" }, "department": { "type": "string", "nullable": true }, "lastActivityDate": { "type": "string", "format": "date-time" }, "groupId": { "type": "integer", "format": "int64" }, "orderNo": { "type": "integer", "format": "int32" }, "autoTicketMaxAssign": { "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "type": "integer", "format": "int32" }, "departmentAccessScope": { "$ref": "#/components/schemas/DepartmentAccessScopeResponse" } }, "additionalProperties": false }, "UserHashModel": { "type": "object", "properties": { "userHash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserNewState": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "state": { "$ref": "#/components/schemas/UserStateType" } }, "additionalProperties": false }, "UserNotifySetting": { "type": "object", "properties": { "notifyType": { "$ref": "#/components/schemas/NotificationType" }, "userId": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "description": "0= Kapalı, 1= Açık", "format": "int32" } }, "additionalProperties": false }, "UserPayloadModel": { "required": [ "displayName", "email" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "profileId": { "type": "integer", "format": "int64", "nullable": true }, "email": { "maxLength": 100, "minLength": 1, "type": "string", "format": "email" }, "personalMailAccountId": { "type": "integer", "format": "int64", "nullable": true }, "displayName": { "maxLength": 128, "minLength": 1, "type": "string" }, "nickname": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "password": { "maxLength": 32, "type": "string", "nullable": true }, "loginType": { "enum": [ "AA==" ], "type": "byte", "description": "

Enum values:

" }, "active": { "type": "integer", "description": "0: Not active, 1:Active", "format": "int32" }, "ipAddress": { "type": "string", "nullable": true }, "gsmNumber": { "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 20, "type": "string", "nullable": true }, "status": { "type": "string" }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "lastActivityDate": { "type": "string", "format": "date-time", "nullable": true }, "userSettings": { "$ref": "#/components/schemas/UserSettings" }, "userNotificationSettings": { "type": "array", "items": { "$ref": "#/components/schemas/UserNotifySetting" }, "nullable": true }, "timeZone": { "$ref": "#/components/schemas/Timezone" }, "accountPlan": { "$ref": "#/components/schemas/AccountPlan" }, "groupIds": { "type": "string", "nullable": true }, "departmentIds": { "type": "string", "nullable": true }, "department": { "type": "string", "nullable": true }, "permissions": { "type": "array", "items": { "$ref": "#/components/schemas/PermissionsRecord" }, "nullable": true }, "expoPushToken": { "type": "string", "description": "Expo push notification Token", "nullable": true }, "isFirstLogin": { "type": "integer", "description": ">1 İlk login değil", "format": "int32" }, "autoTicketMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserRating": { "required": [ "linkedId", "linkedTable", "score" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "score": { "type": "number", "format": "double" }, "message": { "type": "string", "nullable": true }, "linkedId": { "type": "integer", "format": "int64" }, "linkedTable": { "$ref": "#/components/schemas/Table" }, "createdUserId": { "type": "integer", "format": "int64" }, "agentId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UserRatingQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserRating" }, "nullable": true } }, "additionalProperties": false }, "UserReactionCreateModel": { "required": [ "reaction" ], "type": "object", "properties": { "reaction": { "minLength": 1, "pattern": "[#*0-9]\\uFE0F?\\u20E3|\\u00A9\\uFE0F?|[\\u00AE\\u203C\\u2049\\u2122\\u2139\\u2194-\\u2199\\u21A9\\u21AA]\\uFE0F?|[\\u231A\\u231B]|[\\u2328\\u23CF]\\uFE0F?|[\\u23E9-\\u23EC]|[\\u23ED-\\u23EF]\\uFE0F?|\\u23F0|[\\u23F1\\u23F2]\\uFE0F?|\\u23F3|[\\u23F8-\\u23FA\\u24C2\\u25AA\\u25AB\\u25B6\\u25C0\\u25FB\\u25FC]\\uFE0F?|[\\u25FD\\u25FE]|[\\u2600-\\u2604\\u260E\\u2611]\\uFE0F?|[\\u2614\\u2615]|\\u2618\\uFE0F?|\\u261D(?:\\uD83C[\\uDFFB-\\uDFFF]|\\uFE0F)?|[\\u2620\\u2622\\u2623\\u2626\\u262A\\u262E\\u262F\\u2638-\\u263A\\u2640\\u2642]\\uFE0F?|[\\u2648-\\u2653]|[\\u265F\\u2660\\u2663\\u2665\\u2666\\u2668\\u267B\\u267E]\\uFE0F?|\\u267F|\\u2692\\uFE0F?|\\u2693|[\\u2694-\\u2697\\u2699\\u269B\\u269C\\u26A0]\\uFE0F?|\\u26A1|\\u26A7\\uFE0F?|[\\u26AA\\u26AB]|[\\u26B0\\u26B1]\\uFE0F?|[\\u26BD\\u26BE\\u26C4\\u26C5]|\\u26C8\\uFE0F?|\\u26CE|[\\u26CF\\u26D1\\u26D3]\\uFE0F?|\\u26D4|\\u26E9\\uFE0F?|\\u26EA|[\\u26F0\\u26F1]\\uFE0F?|[\\u26F2\\u26F3]|\\u26F4\\uFE0F?|\\u26F5|[\\u26F7\\u26F8]\\uFE0F?|\\u26F9(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|\\uFE0F(?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\u26FA\\u26FD]|\\u2702\\uFE0F?|\\u2705|[\\u2708\\u2709]\\uFE0F?|[\\u270A\\u270B](?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\u270C\\u270D](?:\\uD83C[\\uDFFB-\\uDFFF]|\\uFE0F)?|\\u270F\\uFE0F?|[\\u2712\\u2714\\u2716\\u271D\\u2721]\\uFE0F?|\\u2728|[\\u2733\\u2734\\u2744\\u2747]\\uFE0F?|[\\u274C\\u274E\\u2753-\\u2755\\u2757]|\\u2763\\uFE0F?|\\u2764(?:\\u200D(?:\\uD83D\\uDD25|\\uD83E\\uDE79)|\\uFE0F(?:\\u200D(?:\\uD83D\\uDD25|\\uD83E\\uDE79))?)?|[\\u2795-\\u2797]|\\u27A1\\uFE0F?|[\\u27B0\\u27BF]|[\\u2934\\u2935\\u2B05-\\u2B07]\\uFE0F?|[\\u2B1B\\u2B1C\\u2B50\\u2B55]|[\\u3030\\u303D\\u3297\\u3299]\\uFE0F?|\\uD83C(?:[\\uDC04\\uDCCF]|[\\uDD70\\uDD71\\uDD7E\\uDD7F]\\uFE0F?|[\\uDD8E\\uDD91-\\uDD9A]|\\uDDE6\\uD83C[\\uDDE8-\\uDDEC\\uDDEE\\uDDF1\\uDDF2\\uDDF4\\uDDF6-\\uDDFA\\uDDFC\\uDDFD\\uDDFF]|\\uDDE7\\uD83C[\\uDDE6\\uDDE7\\uDDE9-\\uDDEF\\uDDF1-\\uDDF4\\uDDF6-\\uDDF9\\uDDFB\\uDDFC\\uDDFE\\uDDFF]|\\uDDE8\\uD83C[\\uDDE6\\uDDE8\\uDDE9\\uDDEB-\\uDDEE\\uDDF0-\\uDDF5\\uDDF7\\uDDFA-\\uDDFF]|\\uDDE9\\uD83C[\\uDDEA\\uDDEC\\uDDEF\\uDDF0\\uDDF2\\uDDF4\\uDDFF]|\\uDDEA\\uD83C[\\uDDE6\\uDDE8\\uDDEA\\uDDEC\\uDDED\\uDDF7-\\uDDFA]|\\uDDEB\\uD83C[\\uDDEE-\\uDDF0\\uDDF2\\uDDF4\\uDDF7]|\\uDDEC\\uD83C[\\uDDE6\\uDDE7\\uDDE9-\\uDDEE\\uDDF1-\\uDDF3\\uDDF5-\\uDDFA\\uDDFC\\uDDFE]|\\uDDED\\uD83C[\\uDDF0\\uDDF2\\uDDF3\\uDDF7\\uDDF9\\uDDFA]|\\uDDEE\\uD83C[\\uDDE8-\\uDDEA\\uDDF1-\\uDDF4\\uDDF6-\\uDDF9]|\\uDDEF\\uD83C[\\uDDEA\\uDDF2\\uDDF4\\uDDF5]|\\uDDF0\\uD83C[\\uDDEA\\uDDEC-\\uDDEE\\uDDF2\\uDDF3\\uDDF5\\uDDF7\\uDDFC\\uDDFE\\uDDFF]|\\uDDF1\\uD83C[\\uDDE6-\\uDDE8\\uDDEE\\uDDF0\\uDDF7-\\uDDFB\\uDDFE]|\\uDDF2\\uD83C[\\uDDE6\\uDDE8-\\uDDED\\uDDF0-\\uDDFF]|\\uDDF3\\uD83C[\\uDDE6\\uDDE8\\uDDEA-\\uDDEC\\uDDEE\\uDDF1\\uDDF4\\uDDF5\\uDDF7\\uDDFA\\uDDFF]|\\uDDF4\\uD83C\\uDDF2|\\uDDF5\\uD83C[\\uDDE6\\uDDEA-\\uDDED\\uDDF0-\\uDDF3\\uDDF7-\\uDDF9\\uDDFC\\uDDFE]|\\uDDF6\\uD83C\\uDDE6|\\uDDF7\\uD83C[\\uDDEA\\uDDF4\\uDDF8\\uDDFA\\uDDFC]|\\uDDF8\\uD83C[\\uDDE6-\\uDDEA\\uDDEC-\\uDDF4\\uDDF7-\\uDDF9\\uDDFB\\uDDFD-\\uDDFF]|\\uDDF9\\uD83C[\\uDDE6\\uDDE8\\uDDE9\\uDDEB-\\uDDED\\uDDEF-\\uDDF4\\uDDF7\\uDDF9\\uDDFB\\uDDFC\\uDDFF]|\\uDDFA\\uD83C[\\uDDE6\\uDDEC\\uDDF2\\uDDF3\\uDDF8\\uDDFE\\uDDFF]|\\uDDFB\\uD83C[\\uDDE6\\uDDE8\\uDDEA\\uDDEC\\uDDEE\\uDDF3\\uDDFA]|\\uDDFC\\uD83C[\\uDDEB\\uDDF8]|\\uDDFD\\uD83C\\uDDF0|\\uDDFE\\uD83C[\\uDDEA\\uDDF9]|\\uDDFF\\uD83C[\\uDDE6\\uDDF2\\uDDFC]|\\uDE01|\\uDE02\\uFE0F?|[\\uDE1A\\uDE2F\\uDE32-\\uDE36]|\\uDE37\\uFE0F?|[\\uDE38-\\uDE3A\\uDE50\\uDE51\\uDF00-\\uDF20]|[\\uDF21\\uDF24-\\uDF2C]\\uFE0F?|[\\uDF2D-\\uDF35]|\\uDF36\\uFE0F?|[\\uDF37-\\uDF7C]|\\uDF7D\\uFE0F?|[\\uDF7E-\\uDF84]|\\uDF85(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDF86-\\uDF93]|[\\uDF96\\uDF97\\uDF99-\\uDF9B\\uDF9E\\uDF9F]\\uFE0F?|[\\uDFA0-\\uDFC1]|\\uDFC2(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDFC3\\uDFC4](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDFC5\\uDFC6]|\\uDFC7(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDFC8\\uDFC9]|\\uDFCA(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDFCB\\uDFCC](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|\\uFE0F(?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDFCD\\uDFCE]\\uFE0F?|[\\uDFCF-\\uDFD3]|[\\uDFD4-\\uDFDF]\\uFE0F?|[\\uDFE0-\\uDFF0]|\\uDFF3(?:\\u200D(?:\\u26A7\\uFE0F?|\\uD83C\\uDF08)|\\uFE0F(?:\\u200D(?:\\u26A7\\uFE0F?|\\uD83C\\uDF08))?)?|\\uDFF4(?:\\u200D\\u2620\\uFE0F?|\\uDB40\\uDC67\\uDB40\\uDC62\\uDB40(?:\\uDC65\\uDB40\\uDC6E\\uDB40\\uDC67|\\uDC73\\uDB40\\uDC63\\uDB40\\uDC74|\\uDC77\\uDB40\\uDC6C\\uDB40\\uDC73)\\uDB40\\uDC7F)?|[\\uDFF5\\uDFF7]\\uFE0F?|[\\uDFF8-\\uDFFF])|\\uD83D(?:[\\uDC00-\\uDC07]|\\uDC08(?:\\u200D\\u2B1B)?|[\\uDC09-\\uDC14]|\\uDC15(?:\\u200D\\uD83E\\uDDBA)?|[\\uDC16-\\uDC3A]|\\uDC3B(?:\\u200D\\u2744\\uFE0F?)?|[\\uDC3C-\\uDC3E]|\\uDC3F\\uFE0F?|\\uDC40|\\uDC41(?:\\u200D\\uD83D\\uDDE8\\uFE0F?|\\uFE0F(?:\\u200D\\uD83D\\uDDE8\\uFE0F?)?)?|[\\uDC42\\uDC43](?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC44\\uDC45]|[\\uDC46-\\uDC50](?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC51-\\uDC65]|[\\uDC66\\uDC67](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC68(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D(?:\\uDC66(?:\\u200D\\uD83D\\uDC66)?|\\uDC67(?:\\u200D\\uD83D[\\uDC66\\uDC67])?|[\\uDC68\\uDC69]\\u200D\\uD83D(?:\\uDC66(?:\\u200D\\uD83D\\uDC66)?|\\uDC67(?:\\u200D\\uD83D[\\uDC66\\uDC67])?)|[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92])|\\uD83E[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])|\\uD83C(?:\\uDFFB(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68\\uD83C[\\uDFFB-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D\\uDC68\\uD83C[\\uDFFC-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFC(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68\\uD83C[\\uDFFB-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D\\uDC68\\uD83C[\\uDFFB\\uDFFD-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFD(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68\\uD83C[\\uDFFB-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D\\uDC68\\uD83C[\\uDFFB\\uDFFC\\uDFFE\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFE(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68\\uD83C[\\uDFFB-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D\\uDC68\\uD83C[\\uDFFB-\\uDFFD\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFF(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?\\uDC68\\uD83C[\\uDFFB-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D\\uDC68\\uD83C[\\uDFFB-\\uDFFE]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?))?|\\uDC69(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:\\uDC8B\\u200D\\uD83D)?[\\uDC68\\uDC69]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D(?:\\uDC66(?:\\u200D\\uD83D\\uDC66)?|\\uDC67(?:\\u200D\\uD83D[\\uDC66\\uDC67])?|\\uDC69\\u200D\\uD83D(?:\\uDC66(?:\\u200D\\uD83D\\uDC66)?|\\uDC67(?:\\u200D\\uD83D[\\uDC66\\uDC67])?)|[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92])|\\uD83E[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])|\\uD83C(?:\\uDFFB(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF]|\\uDC8B\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF])|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFC-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFC(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF]|\\uDC8B\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF])|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB\\uDFFD-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFD(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF]|\\uDC8B\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF])|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB\\uDFFC\\uDFFE\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFE(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF]|\\uDC8B\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF])|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFD\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFF(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D\\uD83D(?:[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF]|\\uDC8B\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFF])|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83D[\\uDC68\\uDC69]\\uD83C[\\uDFFB-\\uDFFE]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?))?|\\uDC6A|[\\uDC6B-\\uDC6D](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC6E(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDC6F(?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|[\\uDC70\\uDC71](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDC72(?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC73(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDC74-\\uDC76](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC77(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDC78(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC79-\\uDC7B]|\\uDC7C(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC7D-\\uDC80]|[\\uDC81\\uDC82](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDC83(?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC84|\\uDC85(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC86\\uDC87](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDC88-\\uDC8E]|\\uDC8F(?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDC90|\\uDC91(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDC92-\\uDCA9]|\\uDCAA(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDCAB-\\uDCFC]|\\uDCFD\\uFE0F?|[\\uDCFF-\\uDD3D]|[\\uDD49\\uDD4A]\\uFE0F?|[\\uDD4B-\\uDD4E\\uDD50-\\uDD67]|[\\uDD6F\\uDD70\\uDD73]\\uFE0F?|\\uDD74(?:\\uD83C[\\uDFFB-\\uDFFF]|\\uFE0F)?|\\uDD75(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|\\uFE0F(?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDD76-\\uDD79]\\uFE0F?|\\uDD7A(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD87\\uDD8A-\\uDD8D]\\uFE0F?|\\uDD90(?:\\uD83C[\\uDFFB-\\uDFFF]|\\uFE0F)?|[\\uDD95\\uDD96](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDDA4|[\\uDDA5\\uDDA8\\uDDB1\\uDDB2\\uDDBC\\uDDC2-\\uDDC4\\uDDD1-\\uDDD3\\uDDDC-\\uDDDE\\uDDE1\\uDDE3\\uDDE8\\uDDEF\\uDDF3\\uDDFA]\\uFE0F?|[\\uDDFB-\\uDE2D]|\\uDE2E(?:\\u200D\\uD83D\\uDCA8)?|[\\uDE2F-\\uDE34]|\\uDE35(?:\\u200D\\uD83D\\uDCAB)?|\\uDE36(?:\\u200D\\uD83C\\uDF2B\\uFE0F?)?|[\\uDE37-\\uDE44]|[\\uDE45-\\uDE47](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDE48-\\uDE4A]|\\uDE4B(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDE4C(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDE4D\\uDE4E](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDE4F(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDE80-\\uDEA2]|\\uDEA3(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDEA4-\\uDEB3]|[\\uDEB4-\\uDEB6](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDEB7-\\uDEBF]|\\uDEC0(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDEC1-\\uDEC5]|\\uDECB\\uFE0F?|\\uDECC(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDECD-\\uDECF]\\uFE0F?|[\\uDED0-\\uDED2\\uDED5-\\uDED7\\uDEDD-\\uDEDF]|[\\uDEE0-\\uDEE5\\uDEE9]\\uFE0F?|[\\uDEEB\\uDEEC]|[\\uDEF0\\uDEF3]\\uFE0F?|[\\uDEF4-\\uDEFC\\uDFE0-\\uDFEB\\uDFF0])|\\uD83E(?:\\uDD0C(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD0D\\uDD0E]|\\uDD0F(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD10-\\uDD17]|[\\uDD18-\\uDD1F](?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD20-\\uDD25]|\\uDD26(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDD27-\\uDD2F]|[\\uDD30-\\uDD34](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDD35(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDD36(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD37-\\uDD39](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDD3A|\\uDD3C(?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|[\\uDD3D\\uDD3E](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDD3F-\\uDD45\\uDD47-\\uDD76]|\\uDD77(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDD78-\\uDDB4]|[\\uDDB5\\uDDB6](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDDB7|[\\uDDB8\\uDDB9](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDDBA|\\uDDBB(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDDBC-\\uDDCC]|[\\uDDCD-\\uDDCF](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDDD0|\\uDDD1(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD]))|\\uD83C(?:\\uDFFB(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D(?:\\uD83D\\uDC8B\\u200D)?\\uD83E\\uDDD1\\uD83C[\\uDFFC-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFC(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D(?:\\uD83D\\uDC8B\\u200D)?\\uD83E\\uDDD1\\uD83C[\\uDFFB\\uDFFD-\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFD(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D(?:\\uD83D\\uDC8B\\u200D)?\\uD83E\\uDDD1\\uD83C[\\uDFFB\\uDFFC\\uDFFE\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFE(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D(?:\\uD83D\\uDC8B\\u200D)?\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFD\\uDFFF]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?|\\uDFFF(?:\\u200D(?:[\\u2695\\u2696\\u2708]\\uFE0F?|\\u2764\\uFE0F?\\u200D(?:\\uD83D\\uDC8B\\u200D)?\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFE]|\\uD83C[\\uDF3E\\uDF73\\uDF7C\\uDF84\\uDF93\\uDFA4\\uDFA8\\uDFEB\\uDFED]|\\uD83D[\\uDCBB\\uDCBC\\uDD27\\uDD2C\\uDE80\\uDE92]|\\uD83E(?:\\uDD1D\\u200D\\uD83E\\uDDD1\\uD83C[\\uDFFB-\\uDFFF]|[\\uDDAF-\\uDDB3\\uDDBC\\uDDBD])))?))?|[\\uDDD2\\uDDD3](?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDDD4(?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|\\uDDD5(?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDDD6-\\uDDDD](?:\\u200D[\\u2640\\u2642]\\uFE0F?|\\uD83C[\\uDFFB-\\uDFFF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?)?|[\\uDDDE\\uDDDF](?:\\u200D[\\u2640\\u2642]\\uFE0F?)?|[\\uDDE0-\\uDDFF\\uDE70-\\uDE74\\uDE78-\\uDE7C\\uDE80-\\uDE86\\uDE90-\\uDEAC\\uDEB0-\\uDEBA\\uDEC0-\\uDEC2]|[\\uDEC3-\\uDEC5](?:\\uD83C[\\uDFFB-\\uDFFF])?|[\\uDED0-\\uDED9\\uDEE0-\\uDEE7]|\\uDEF0(?:\\uD83C[\\uDFFB-\\uDFFF])?|\\uDEF1(?:\\uD83C(?:\\uDFFB(?:\\u200D\\uD83E\\uDEF2\\uD83C[\\uDFFC-\\uDFFF])?|\\uDFFC(?:\\u200D\\uD83E\\uDEF2\\uD83C[\\uDFFB\\uDFFD-\\uDFFF])?|\\uDFFD(?:\\u200D\\uD83E\\uDEF2\\uD83C[\\uDFFB\\uDFFC\\uDFFE\\uDFFF])?|\\uDFFE(?:\\u200D\\uD83E\\uDEF2\\uD83C[\\uDFFB-\\uDFFD\\uDFFF])?|\\uDFFF(?:\\u200D\\uD83E\\uDEF2\\uD83C[\\uDFFB-\\uDFFE])?))?|[\\uDEF2-\\uDEF6](?:\\uD83C[\\uDFFB-\\uDFFF])?)", "type": "string" } }, "additionalProperties": false }, "UserReactionResponseModel": { "type": "object", "properties": { "reactionId": { "type": "integer", "format": "int64" }, "reaction": { "type": "string", "nullable": true }, "userId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UserResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "email": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "nickname": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "loginType": { "enum": [ "AA==" ], "type": "byte", "description": "

Enum values:

" }, "active": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string", "nullable": true }, "gsmNumber": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "status": { "type": "string" }, "department": { "type": "string", "nullable": true }, "departmentIds": { "type": "string", "nullable": true }, "isAdmin": { "type": "boolean" }, "profileId": { "type": "integer", "format": "int64", "nullable": true }, "profileName": { "type": "string", "nullable": true }, "lastActivityDate": { "type": "string", "format": "date-time" }, "groupIds": { "type": "string", "nullable": true }, "groups": { "type": "string", "nullable": true }, "autoTicketMaxAssign": { "type": "integer", "format": "int32" }, "autoDealMaxAssign": { "type": "integer", "format": "int32" }, "autoChatMaxAssign": { "type": "integer", "format": "int32" }, "userSettings": { "$ref": "#/components/schemas/UserSettings" } }, "additionalProperties": false }, "UserResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserResponseModel" }, "nullable": true } }, "additionalProperties": false }, "UserSettings": { "type": "object", "properties": { "userId": { "type": "integer", "format": "int64" }, "defaultTimezoneId": { "type": "integer", "format": "int32" }, "defaultLanguage": { "type": "string", "nullable": true }, "defaultCurrency": { "type": "string", "nullable": true }, "allowSuperadminAccess": { "type": "integer", "format": "int32" }, "shortcutsEnabled": { "type": "integer", "format": "int32", "default": 1 }, "nickname": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "defaultCallExtension": { "type": "string", "nullable": true }, "mfaEnabled": { "type": "boolean", "description": "Whether user has enabled multi-factor authentication" }, "mfaMethod": { "$ref": "#/components/schemas/MfaMethod" }, "previewSettings": { "type": "string", "description": "Preview settings for deals and tickets in JSON format\r\nExample: {\"deal\": true, \"ticket\": true}", "nullable": true } }, "additionalProperties": false }, "UserStateType": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ViewType": { "enum": [ 0, 1 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "VisibilityType": { "enum": [ 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "Voicemail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "voipUserId": { "type": "integer", "format": "int64" }, "callCenterQueueId": { "type": "integer", "format": "int64" }, "contactId": { "type": "integer", "format": "int64" }, "companyId": { "type": "integer", "format": "int64" }, "createdDate": { "type": "string", "format": "date-time" }, "callDuration": { "type": "integer", "format": "int32" }, "listenStatus": { "type": "boolean" }, "callerNumber": { "type": "string", "nullable": true }, "calledNumber": { "type": "string", "nullable": true }, "dtmf": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "directory": { "type": "string", "nullable": true }, "s3BucketName": { "type": "string", "nullable": true }, "s3Key": { "type": "string", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "VoicemailQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Voicemail" }, "nullable": true } }, "additionalProperties": false }, "VoipGatewayType": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "VoipProvider": { "required": [ "externalNumber", "gatewayType", "ipAddress", "name", "virtualExtNumber" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "maxLength": 50, "minLength": 1, "type": "string", "description": "IP Kullanıcı Adı" }, "gatewayType": { "$ref": "#/components/schemas/VoipGatewayType" }, "maxChannelCount": { "type": "integer", "description": "Maksimum Kanal Sayısı", "format": "int32" }, "ipAddress": { "minLength": 1, "type": "string", "description": "Servis Sağlayıcı IP Adresi" }, "port": { "type": "integer", "description": "Servis Sağlayıcı Port Numarası", "format": "int32" }, "outboundProxyIp": { "type": "string", "description": "Servis Sağlayıcı Proxy IP Adresi", "nullable": true }, "outboundProxyPort": { "type": "integer", "description": "Servis Sağlayıcı Proxy Port Numarası", "format": "int32" }, "externalNumber": { "minLength": 1, "type": "string", "description": "Dış Hat Numarası" }, "virtualExtNumber": { "minLength": 1, "type": "string", "description": "Sanal Dahili Numarası" }, "voipUserName": { "type": "string", "description": "IP Kullanıcı Adı", "nullable": true }, "voipPassword": { "type": "string", "description": "IP Kullanıcı Şifresi", "nullable": true }, "registerTimeout": { "type": "integer", "description": "Sip Server Bağlantı Zaman Aşımı (sn cinsinden)", "format": "int32" }, "codecList": { "type": "string", "description": "GSM=0,ILBC=1,G711A=2,G711U=3,G729=4", "nullable": true }, "registerType": { "type": "integer", "description": "Sip server'a register ol, 1:gateway register olsun", "format": "int32" }, "sendEmailOffHourCalls": { "type": "integer", "description": "0: Hayır, 1:Mesai dışı çağrıları varsa sesli postaları ile mail gönder", "format": "int32" }, "toAddress": { "type": "string", "description": "Alıcı eposta listesi", "nullable": true }, "active": { "type": "integer", "description": "0: Not active, 1: Active", "format": "int32" }, "registered": { "type": "boolean", "description": "true: gateway is currently registered with the SIP server.\r\nfalse / null: registration failed or never attempted.\r\nUpdated by CallServer on OnLineRegisterSuccess / OnLineRegisterFailed events.", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "VoipProviderResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "name": { "type": "string", "nullable": true }, "virtualExtNumber": { "type": "string", "nullable": true }, "externalNumber": { "type": "string", "nullable": true }, "ipAddress": { "type": "string", "nullable": true }, "port": { "type": "integer", "format": "int32" }, "codecList": { "type": "string", "nullable": true }, "sendEmailOffHourCalls": { "type": "integer", "format": "int32" }, "toAddress": { "type": "string", "nullable": true }, "active": { "type": "integer", "format": "int32" }, "registered": { "type": "boolean", "nullable": true }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "VoipProviderResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VoipProviderResponseModel" }, "nullable": true } }, "additionalProperties": false }, "VoipSettings": { "required": [ "agentStatusPrefixCode", "arealCode" ], "type": "object", "properties": { "departmentId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "sipServerId": { "type": "integer", "format": "int64" }, "arealCode": { "maxLength": 10, "minLength": 1, "type": "string", "description": "Alan kodu" }, "operatorExtNumber": { "type": "string", "description": "Operatör dahili numarası", "nullable": true }, "transferPrefixCode": { "type": "string", "description": "Çağrıyı Aktarma, Beklemeye Alma veya Beklemeden Geri Alma Kodu", "nullable": true }, "redirectPrefixCode": { "type": "string", "description": "Telefonu Yönlendirme ve Geri Alma Tuş Prefixi (#31000 1000 nolu dahiliye çağrıları yönlendir, #3 yönlendirmeyi geri\r\nal gibi)", "nullable": true }, "callPickUpPrefixCode": { "type": "string", "description": "Çağrı Çekme Tuş Prefixi (#41000 1000 nolu dahilinin çağrısını çek, #45000 5000 nolu çağrı merkezinin çağrısını çek\r\ngibi)", "nullable": true }, "voiceMailPrefixCode": { "type": "string", "description": "Sesli Postalara Doğrudan Erişim Tuş Prefixi (#51000 1000 nolu dahilinin posta kutusuna erişim numarası gibi)", "nullable": true }, "agentStatusPrefixCode": { "minLength": 1, "type": "string", "description": "Agent Login Durumu Değiştirme Prefix Kodu (#61: Aktif Duruma Geç Gibi...)" }, "supervisorMonitorPrefixCode": { "type": "string", "description": "Süpervizör Görüşme İzleme Prefix Kodu (#71000 1000 nolu dahili numaranın görüşmesini izle gibi)", "nullable": true }, "surveyTransferCode": { "type": "string", "description": "Çağrıyı manuel anket menüsüne yönlendirme tuşu (*2 gibi)", "nullable": true }, "voiceMailListenNumber": { "type": "string", "description": "Sesli Mesajları Dinleme Dahili Numarası", "nullable": true }, "dtmfDetectionFlag": { "type": "integer", "description": "Bit-0: RFC2833, Bit-1:Ses içerisinde DTMF Tonu, Bit-2:SIP", "format": "int32" }, "minActiveAgentCount": { "type": "integer", "description": "Sistemde kalacak min. aktif agent sayısı =0 ise dikkate alınmaz", "format": "int32" }, "conferenceActive": { "type": "integer", "description": "whisper-barge-in tarafnda 2 tuşunu iptal eder", "format": "int32" }, "compressCall": { "type": "integer", "description": "Çağrı kayıtlarının MP3 olarak sıkıştırılıp sıkıştırılmayacağı", "format": "int32" }, "compressVoicemail": { "type": "integer", "description": "Sesli mesaj kayıtlarının MP3 olarak sıkıştırılıp sıkıştırılmayacağı", "format": "int32" } }, "additionalProperties": false }, "VoipUser": { "required": [ "extNumber", "password", "userName" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "displayName": { "type": "string", "description": "Display name joined from USERS.DISPLAY_NAME (falls back to empty string).", "nullable": true }, "phone1": { "type": "string", "description": "Operator primary phone (from user_settings.PHONE1 if joined).", "nullable": true }, "phone2": { "type": "string", "description": "Operator secondary phone (from user_settings.PHONE2 if joined).", "nullable": true }, "userName": { "maxLength": 50, "minLength": 1, "type": "string", "description": "IP Kullanıcı Adı" }, "password": { "maxLength": 40, "minLength": 1, "type": "string", "description": "IP Kullanıcı Şifresi, cryptolu" }, "extNumber": { "maxLength": 20, "minLength": 1, "type": "string", "description": "IP Dahili Numarası" }, "ownerUserId": { "type": "integer", "description": "VOIP hesabının ait olduğu Kullanıcı ID", "format": "int64" }, "status": { "type": "integer", "description": "1=Aktif, 0=Pasif, 2=Deleted", "format": "int32" }, "recordOutgoingCall": { "type": "integer", "description": "Giden Arama Kayıt Durumu , =0 Yok, =1 Var", "format": "int32" }, "recordIncomingCall": { "type": "integer", "description": "Gelen Arama Kayıt Durumu , =0 Yok, =1 Var", "format": "int32" }, "voiceMailStatus": { "type": "integer", "description": "Sesli Mesaj Durumu 0:Yok, 1:Var", "format": "int32" }, "voiceMailPinStatus": { "type": "integer", "description": "Sesli Mesaj Dinlemede Pin Kodu Sorma Durumu 0:Yok, 1:Var", "format": "int32" }, "voiceMailPinCode": { "maxLength": 4, "type": "string", "description": "Sesli Mesaj Pin Kodu (4 Haneli Rakam)", "nullable": true }, "codecList": { "type": "string", "description": "GSM=0,ILBC=1,G711A=2,G711U=3,G729=4", "nullable": true }, "workingHourType": { "type": "integer", "description": "Çalışma Saatleri Seçeneği 0:Yok, 1: Sistem Ayarları Mesai Saati Kullan, 2: Özel Mesai Saati Kullan", "format": "int32" }, "userType": { "type": "integer", "description": "Tipi 0:Normal, 1: Supervizor, 2: agent, 3: Sanal (IP Trunk ile Santral Dahilisi için)", "format": "int32" }, "virtualNumber": { "type": "string", "description": "USER_TYPE Sanal ise Kullanılacak Numara", "nullable": true }, "createdUserId": { "type": "integer", "format": "int64", "readOnly": true }, "createdDate": { "type": "string", "format": "date-time", "readOnly": true }, "updatedUserId": { "type": "integer", "format": "int64", "readOnly": true }, "updatedDate": { "type": "string", "format": "date-time", "readOnly": true }, "redirectActionType": { "type": "integer", "description": "Çağrı Geldiğinde Doğrudan Yönlendirme Tanımları (Yok ise wav dosya ve parametre gösterilmeyecek)\r\nYapılacak İşlem;\r\n0: Yok,\r\n1: Dahiliye Aktar,\r\n2: Dahili Posta Kutusuna Aktar,\r\n3: Çağrı Merkezi Grubuna Aktar\r\n4: Çağrı Merkezi Grubu Posta Kutusuna Aktar,\r\n5: Numaraya Aktar,\r\n6: Sesli Yanıt Sistemine Aktar,\r\n7: Hattı Kapat", "format": "int32" }, "redirectWavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "redirectActionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "outOfOfficeActionType": { "type": "integer", "description": "Mesai Saati Dışında Yönlendirme Tanımları (Yok ise wav dosya ve parametre gösterilmeyecek)", "format": "int32" }, "outOfOfficeWavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "outOfOfficeActionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "notRegisterActionType": { "type": "integer", "description": "Register Değilse Yönlendirme Tanımları (Yok ise wav dosya ve parametre gösterilmeyecek)", "format": "int32" }, "notRegisterWavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "notRegisterActionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "busyActionType": { "type": "integer", "description": "Meşgul ise Yönlendirme Tanımları", "format": "int32" }, "busyWavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "busyActionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "noAnswerActionType": { "type": "integer", "description": "Cevap Yok ise Yönlendirme Tanımları", "format": "int32" }, "noAnswerWaitTime": { "type": "integer", "description": "Cevap Bekleme Süresi (sn)", "format": "int32", "default": 60 }, "noAnswerWavFile": { "type": "string", "description": "İşlemden Önce Okunacak Wav Dosyası", "nullable": true }, "noAnswerActionParameter": { "type": "string", "description": "İşlem Parametresi", "nullable": true }, "holdLineEnabled": { "type": "integer", "description": "Çağrıyı Bekletmeye Alma Yetkisi , =0 Yok, =1 Var", "format": "int32" }, "transferCallEnabled": { "type": "integer", "description": "Çağrıyı Aktarma Yetkisi , =0 Yok, =1 Var", "format": "int32" }, "popupStatus": { "type": "integer", "description": "Çağrı merkezi için gelen çağrılarda pop-up sayfa aç", "format": "int32" }, "popupPage": { "type": "string", "description": "Açılacak sayfa {ticket}, {deal} yada harici web sayfa linki", "nullable": true }, "popupOutboundStatus": { "type": "integer", "description": "Çağrı merkezi için giden (outbound) çağrılarda pop-up sayfa aç. =0 Yok, =1 Var.\r\nGelen çağrılar için Infoset.Types.Models.VoipUser.PopupStatus kullanılır.", "format": "int32" }, "sipServerId": { "type": "integer", "format": "int64" }, "userState": { "type": "integer", "description": "Operator state (legacy USER_STATE column, tri-state managed via /voip-users/{id}/state).", "format": "int32" }, "queueId": { "type": "integer", "description": "Call center queue the user is currently logged into (0 when not in a queue).", "format": "int64" }, "callAvailability": { "type": "integer", "description": "Call availability state (Available / Busy / DND / Offline).", "format": "int32" }, "defaultCallExtension": { "type": "string", "description": "Derived from user_settings.DEFAULT_CALL_EXTENSION (IFNULL to empty). Used by CallServer\r\nto fall back to an operator's preferred external line when no explicit extension is set.", "nullable": true }, "lastStateStartTime": { "type": "string", "description": "Derived from the latest user_state_log.START_TIME for this operator. Null if the\r\noperator has never logged a state transition.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "VoipUserResponseModel": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentId": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int64" }, "userName": { "type": "string", "nullable": true }, "extNumber": { "type": "string", "nullable": true }, "owner": { "type": "string", "nullable": true }, "userType": { "$ref": "#/components/schemas/VoipUserType" }, "codecList": { "type": "string", "nullable": true }, "recordIncomingCall": { "type": "integer", "format": "int32" }, "recordOutgoingCall": { "type": "integer", "format": "int32" }, "voiceMailStatus": { "type": "integer", "format": "int32" }, "popupPage": { "type": "string", "nullable": true }, "popupStatus": { "type": "integer", "format": "int32" }, "popupOutboundStatus": { "type": "integer", "format": "int32" }, "lastUserState": { "type": "integer", "format": "int32" }, "sipServerId": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "VoipUserResponseModelQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VoipUserResponseModel" }, "nullable": true } }, "additionalProperties": false }, "VoipUserType": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "WorkingHour": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "departmentIds": { "type": "string", "description": "Hizmet verdiği markalar (Çoklu Marka, IDT-444). Virgülle ayrılmış department id listesi.\r\n'' = tüm markalara uygulanır (account-wide / legacy). Bir set birden fazla markaya hizmet edebilir.", "nullable": true }, "groupIndex": { "type": "integer", "format": "int32" }, "dayIndis": { "type": "integer", "description": "1: Monday, 2: Tuesday, ..", "format": "int32" }, "tableType": { "$ref": "#/components/schemas/WorkingHourTable" }, "tableId": { "type": "integer", "description": "Ait Olduğu Tablonun Kayıt ID' si", "format": "int64" }, "startTime": { "type": "string", "nullable": true }, "endTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkingHourQueryResult": { "type": "object", "properties": { "totalItems": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/WorkingHour" }, "nullable": true } }, "additionalProperties": false }, "WorkingHourTable": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "WorkingHourType": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "

Enum values:

", "format": "int32" }, "ZipAttachmentRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header using the Bearer scheme.

\n Enter your token received from the `/v1/login/token` endpoint in the text input below.

\n Example: `12345abcdef...`", "scheme": "Bearer" }, "API Key": { "type": "apiKey", "description": "API key authentication.

\n Enter your API key received from the `https://dashboard.infoset.app/account?tab=api` page in the text input below.

\n Example: `12345678-abcd-1234-8ff7-123abc277819`", "name": "X-Api-Key", "in": "header" } } }, "security": [ { "Bearer": [ ] }, { "API Key": [ ] } ], "tags": [ { "name": "AuditLog", "description": "An audit log is a security-relevant chronological record that provide documentary evidence of the sequence of\r\nactivities that have affected a specific record in Infoset." }, { "name": "Automation", "description": "Automations save time by automatically performing repetitive tasks.\r\nTriggering conditions and filters define when an automation will run (e.g. when a ticket is created, if subject\r\ncontains \"abc\"), actions define what the automation will do (e.g. assign to Jack)." }, { "name": "CallCenter", "description": "Everything related to calls (call center settings, making/receiving calls etc.) is under this namespace." }, { "name": "SipServer", "description": "SIP Server admin CRUD (SuperAdmin-only). sip_servers is a global resource; no per-account tenancy\r\napplies. Auth is enforced per-endpoint by checking CallCenterService._loginTypeTask." }, { "name": "UserGroup", "description": "User groups attached to a user defines what that user can do in Infoset.\r\nDifferent user groups can be created to ensure that different teams has access to only the relevant Infoset\r\nmodules." }, { "name": "CopilotConfig", "description": "IDT-788 — Internal read-only endpoint exposing each account's Copilot/AI configuration\r\nto the AI sidecar services. Authenticated via the shared-secret\r\nInfoset.Api.Middlewares.InternalServiceAuthAttribute (IDT-903), so no JWT and no\r\n`RightModule` gate — the callers are the AI services that gate work on a\r\ntenant's AI-enabled flag (copilot — the embedding-service reuses the copilot key —\r\nplus intent, sentiment, customer-context).\r\n \r\nThe sidecar caches the response for ~60s on its side; we don't add a server-side\r\ncache here because the Settings page already invalidates implicitly on PUT and the\r\nquery is a single primary-key lookup." }, { "name": "GenAiChatOwnership", "description": "Lets the gen-ai assistant claim a chat room, so its involvement is visible in the same place\r\nevery other owner's is." }, { "name": "GenAiConfig", "description": "Internal read-only endpoint exposing one brand's resolved gen-ai configuration to the gen-ai\r\nservice. Authenticated by the shared-secret Infoset.Api.Middlewares.InternalServiceAuthAttribute, so no\r\nJWT and no `RightModule` gate — the caller is a service identity with no tenant scope of\r\nits own, which is why both ids must be explicit in the query string.\r\n \r\nAccepts the gen-ai identity AND the shared Copilot one (OR semantics). The dual-accept is the\r\nrollout mechanism, not indecision: the boot validator fails the whole API when a referenced\r\nservice has no configured key, so gen-ai keeps authenticating with the copilot key until every\r\nenvironment's `InternalServiceKeys` carries a `GenAi` entry. Drop the Copilot id from\r\nthe attribute once that is true everywhere.\r\n \r\nNo server-side cache: this is a two-row lookup on primary keys, and the gen-ai client caches\r\nthe response (including the negative) for its own configured TTL." }, { "name": "GenAiHandoff", "description": "Lets the gen-ai assistant hand a live conversation back to a human." }, { "name": "GenAiResolve", "description": "Lets the gen-ai assistant close a conversation it holds and mark it solved." }, { "name": "GenAiTyping", "description": "Lets an internal service raise and lower the visitor's typing indicator. The AI services hold no\r\nSignalR connection of their own, and nothing else in the API exposes the hub's typing method, so\r\nthis relay is the single entry point for it." }, { "name": "KbSyncPlan", "description": "Internal read-only endpoint serving the helpdesk-updater's knowledge-base sync plan.\r\nAuthenticated via the shared-secret Infoset.Api.Middlewares.InternalServiceAuthAttribute (HMAC\r\nservice auth), so there is no JWT and no `RightModule` gate — the caller is the\r\nupdater service (it reuses the Copilot / Embedding keys), not a tenant user.\r\n \r\nAccountId-rule exception: this is a DELIBERATE cross-tenant endpoint. The updater\r\nreconciles ALL accounts in one reconciliation pass, so — unlike every tenant-scoped\r\nendpoint — the underlying queries intentionally do NOT filter by ACCOUNT_ID. There is\r\nno calling tenant to scope to; the service identity has no tenant of its own. The read\r\nis exactly two queries (all departments, all copilot_config selections) grouped in\r\nmemory — no per-account round-trips.\r\n \r\nDesk→department mapping is intentionally NOT included here: it lives in the helpdesk\r\nservice and the updater fetches it there. This endpoint is DB-only." } ] }