Jump to

• Request
• Response

Update a chat interaction - Not supported

patch

/crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}

Request

Path Parameters

• InteractionId(required): integer
  The unique identifier of the interaction.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "transcript":{
            "title":"Transcripts",
            "type":"array",
            "description":"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.\nThe 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.",
            "items":{
                "$ref":"#/components/schemas/chatInteractions-transcript-item-patch-request"
            }
        }
    }
}

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

• Array of: object schema

{
    "title":"Transcripts",
    "type":"array",
    "description":"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.\nThe 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.",
    "items":{
        "$ref":"#/components/schemas/chatInteractions-transcript-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• SenderType: string
  Maximum Length: 100

  The type of the message sender.

{
    "type":"object",
    "properties":{
        "SenderType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the message sender.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : chatInteractions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "InteractionId":{
            "type":"integer",
            "description":"The unique identifier of the interaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "transcript":{
            "title":"Transcripts",
            "type":"array",
            "description":"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.\nThe 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.",
            "items":{
                "$ref":"#/components/schemas/chatInteractions-transcript-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object chatInteractions-transcript-item-response

{
    "title":"Transcripts",
    "type":"array",
    "description":"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.\nThe 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.",
    "items":{
        "$ref":"#/components/schemas/chatInteractions-transcript-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : chatInteractions-transcript-item-response

Type: object

Show Source

• ChatId: integer
  Read Only: true

  The unique identifier of the chat.
• ConversationId: string
  Read Only: true

  Maximum Length: 100

  The unique identifier of the chat conversation.
• 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.

{
    "type":"object",
    "properties":{
        "ChatId":{
            "type":"integer",
            "description":"The unique identifier of the chat.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the chat conversation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageContent":{
            "type":"string",
            "description":"The content of the message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDate":{
            "type":"string",
            "description":"The date and the time when the message is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageId":{
            "type":"integer",
            "description":"The unique identifier of the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageTypeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OsvcChatId":{
            "type":"integer",
            "description":"The identifier assigned to the chat engagement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":900,
            "type":"string",
            "description":"The name of the message sender.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RichTextFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the content of the message is rich text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderId":{
            "type":"integer",
            "description":"The message sender identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SenderType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the message sender.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

transcript

Operation: /crmRestApi/resources/11.13.18.05/chatInteractions/{InteractionId}/child/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.

Back to Top