Create a chat interaction - Not supported
post
/crmRestApi/resources/11.13.18.05/chatInteractions
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
transcript: array
Transcripts
Title:
Transcripts
The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role. The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.
Nested Schema : Transcripts
Type:
array
Title:
Transcripts
The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.
The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.
Show Source
Nested Schema : chatInteractions-transcript-item-post-request
Type:
Show Source
object
-
SenderType: string
Maximum Length:
100
The type of the message sender.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : chatInteractions-item-response
Type:
Show Source
object
-
InteractionId: integer
Read Only:
true
The unique identifier of the interaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Read Only:
true
The unique identifier of the object. -
transcript: array
Transcripts
Title:
Transcripts
The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role. The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transcripts
Type:
array
Title:
Transcripts
The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role.
The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : chatInteractions-transcript-item-response
Type:
Show Source
object
-
ChatId: integer
Read Only:
true
The unique identifier of the chat. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageContent: string
Read Only:
true
The content of the message. -
MessageDate: string
(date-time)
Read Only:
true
The date and the time when the message is created. -
MessageId: integer
Read Only:
true
The unique identifier of the message. -
MessageTypeCd: string
Read Only:
true
Maximum Length:30
The type of the message. -
OsvcChatId: integer
(int64)
Read Only:
true
The identifier assigned to the chat engagement. -
PartyName: string
Read Only:
true
Maximum Length:900
The name of the message sender. -
RichTextFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the content of the message is rich text. -
SenderId: integer
(int64)
Read Only:
true
The message sender identifier. -
SenderType: string
Maximum Length:
100
The type of the message sender.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- transcript
-
Parameters:
- InteractionId:
$request.path.InteractionId
The transcripts resource is used to get the list of chat transcript messages for a chat interaction. The resource can be accessed by DCS authenticated users assigned to the ORA_SVC_CUSTOMER_SELF_SERVICE_USER_ABSTRACT role. The transcript can be accessed only by the DCS user that participated in the chat or by the manager of the DCS user who participated in the chat. - InteractionId: