AfterHours5

AIAgents9

get/aiagents/locations/{locationId}/InitConversationInitializes a new conversation with the necessary setup by creating and configuring the required resources for interaction.
post/aiagents/SendMessageSends a message to the specified thread. This method ensures that the message is delivered according to the provided parameters, including thread and message data.
post/aiagents/SendImageSends an image to the specified thread. This method ensures that the image content is delivered according to the provided parameters, including thread and image data.
get/aiagents/locations/{locationId}/ProcessMessageStreamRetrieves a stream of messages for a specific thread. This method establishes and manages a stream to receive continuous messages.
delete/aiagents/DeleteConversationDeletes a specific conversation from the system. This method removes the conversation and all its associated data permanently.
post/aiagents/CreateConversationCreates a new conversation instance
get/aiagents/ProblemDescriptionRetrieves the description of a specific problem based on the provided issue choice.
post/aiagents/CreateFeedbackSessionCreates a new feedback session for a specific conversation and AI agent
post/aiagents/AddFeedbackAdd a new feedback to exist session for a specific conversation and AI agent

Announcements2

ApplicationAccess1

Assets89

AssetTaskResponse5

AssetTypes25

Attachments31

BatchRfp1

Branding1

Categories6

CheckLists10

Classification2

Compliance5

Contracts5

ContractServiceRates4

Ctools8

Currencies1

DashboardSettings10

EmailNotifications4

Eula2

Feedback7

GlCodes5

Invoices18

IssueList38

LocationNotes2

Locations38

LocationSupply4

MliConfiguration8

MobileTheme7

Notes8

NotificationSubscriptions11

NotificationWebHooks5

OutgoingXml30

Parts10

PlannedMaintenance2

PlatformIntelligence1

Priorities3

Proposals35

ProviderAssignment2

Providers13

PushNotifications4

RefrigerantTracking58

ResolutionCodes8

Rfps6

Roles1

ScConnector10

ServiceRequest10

SingleSignOn4

SiteAudit22

Subscribers10

SupplyClick1

SurveyQuestions5

TemplateFilesHistory1

Trades10

Tradesmen1

Training1

Trucks9

Users15

Weather2

WorkActivities6

WorkOrders65

WorkRequestNote4

WorkRequests14

AIAgents

Retrieves a stream of messages for a specific thread. This method establishes and manages a stream to receive continuous messages.

get/aiagents/locations/{locationId}/ProcessMessageStream

Request

Base URL
https://sb2api.servicechannel.com/v3
Auth
OAuth 2
Authorization codehttps://sb2login.servicechannel.com/oauth/authorize
Token URLhttps://sb2login.servicechannel.com/oauth/token
TypeScript
https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/aiagents/locations/:locationId/ProcessMessageStream/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

locationIdinteger required

The unique identifier of the location.

Query parameters

setupIdinteger required

The identifier of the dashboard setup.

threadIdstring required

The unique identifier of the conversation.

assistantIdstring required

The unique identifier of the AI agent.

enableMetricsboolean

Indicates whether metrics should be enabled. Defaults to false if not specified.

Response

Message stream successfully received.

Changes

No recorded changes to this operation across all 1 revision of this API.