Jump to

• Request
• Response
• Examples

Start a new chat

post

/rest/ofscCollaboration/v1/chats

This operation creates a new chat with another user, helpdesk or a conference chat with a group of users.

Request

Supported Media Types

• application/json

Body ()

The schema of the request body object for this operation.

Root Schema : StartChatRequest

Type: object

The schema of the request body object for this operation.

Show Source

• attachment: object Attachment
• helpdesk: integer
  helpdesk id
• recipients: array recipients
  Minimum Number of Items: 1

  The login of the message recipients in the chat.
• text: string
  Minimum Length: 1

  Maximum Length: 1000

  The content of the message.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"The content of the message.",
            "minLength":"1",
            "maxLength":"1000"
        },
        "attachment":{
            "type":"object",
            "$ref":"#/definitions/Attachment"
        },
        "recipients":{
            "type":"array",
            "description":"The login of the message recipients in the chat.",
            "items":{
                "type":"string"
            },
            "minItems":"1"
        },
        "helpdesk":{
            "type":"integer",
            "description":"helpdesk id"
        }
    },
    "description":"The schema of the request body object for this operation."
}

Nested Schema : Attachment

Type: object

Show Source

• content: object ImageContent
• id: string
  attachment entity ID. activity, resource or inventory ID. no ID field required for image type
• type(required): string
  Allowed Values: [ "activity", "resource", "inventory", "image" ]

  type of attachment

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"type of attachment",
            "enum":[
                "activity",
                "resource",
                "inventory",
                "image"
            ]
        },
        "id":{
            "type":"string",
            "description":"attachment entity ID. activity, resource or inventory ID. no ID field required for image type"
        },
        "content":{
            "type":"object",
            "$ref":"#/definitions/ImageContent"
        }
    },
    "required":[
        "type"
    ]
}

Nested Schema : recipients

Type: array

Minimum Number of Items: 1

The login of the message recipients in the chat.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The login of the message recipients in the chat.",
    "items":{
        "type":"string"
    },
    "minItems":"1"
}

Nested Schema : ImageContent

Type: object

Show Source

• filename(required): string
  image file name
• imageData(required): string
  base64 value of the image content
• mediaType(required): string
  media type

{
    "type":"object",
    "properties":{
        "filename":{
            "type":"string",
            "description":"image file name"
        },
        "mediaType":{
            "type":"string",
            "description":"media type"
        },
        "imageData":{
            "type":"string",
            "description":"base64 value of the image content"
        }
    },
    "required":[
        "filename",
        "mediaType",
        "imageData"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

This section describes the 201 status response for this operation. This response code indicates that the operation completed successfully.

Body ()

Root Schema : StartChatResponse

Type: object

The details of the new chat.

Show Source

• chatId: integer(int64)
  The unique identifier of the chat in Oracle Field Service.
• participants: array participants
  Link to participant of the chat
• startedBy: string
  The login of the user who started the chat. This field is present only for the chats started by a user.
• startedTime: string
  The time (in UTC time zone) when the chat started. The time is in 'YYYY-MM-DD HH:MM:SS' format.
• type: string
  Allowed Values: [ "normal", "conference" ]

  The type of the chat. The possible values of this field are:

  • normal - A chat between two participants
  • conference - A chat with more than two participants

{
    "type":"object",
    "properties":{
        "chatId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the chat in Oracle Field Service."
        },
        "type":{
            "type":"string",
            "description":"<p>The type of the chat. The possible values of this field are:</p><ul><li>normal - A chat between two participants</li><li>conference - A chat with more than two participants</li></ul>",
            "enum":[
                "normal",
                "conference"
            ]
        },
        "startedTime":{
            "type":"string",
            "description":"The time (in UTC time zone) when the chat started. The time is in 'YYYY-MM-DD HH:MM:SS' format."
        },
        "startedBy":{
            "type":"string",
            "description":"The login of the user who started the chat. This field is present only for the chats started by a user."
        },
        "participants":{
            "type":"array",
            "description":"Link to participant of the chat",
            "items":{
                "$ref":"#/definitions/PaginationLink"
            }
        }
    },
    "description":"The details of the new chat."
}

Nested Schema : participants

Type: array

Link to participant of the chat

Show Source

• Array of: object PaginationLink
  The pagination links.

{
    "type":"array",
    "description":"Link to participant of the chat",
    "items":{
        "$ref":"#/definitions/PaginationLink"
    }
}

Nested Schema : PaginationLink

Type: object

The pagination links.

Show Source

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"The pagination links."
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to create a chat with another user or a group of users by submitting a POST request on the REST resource:

cURL command Example

The following shows an example of the cURL command for a normal chat.

curl -X POST "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCollaboration/v1/chats" -H "Accept: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...W7B2fXbKpLz1m-sCG9QQA" -H "Content-Type: application/json" -d "{\"text\" : \"text message\", \"recipients\" : [\"smith\"]}"

The following shows an example of the cURL command for a conference chat.

curl -X POST "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCollaboration/v1/chats" -H "Accept: application/json" -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...W7B2fXbKpLz1m-sCG9QQA" -H "Content-Type: application/json" -d "{\"text\" : \"test message\", \"recipients\" : [\"miller\", \"smith\"]}"

Response Header Example

The following shows an example of the response header.

HTTP/1.1 201 OK
Server: nginx
Date: Thu, 22 Apr 2019 16:28:18 GMT
Content-Type: application/json; charset=utf-8
Connection: close

Response Body Example

The following shows an example of the response body in JSON format.

{
    "chatId": 2,
    "type": "normal",
    "startedBy": "williams",
    "startedTime": "2019-04-22 11:46:58",
    "participants": {
        "links": [
            {
                "rel": "canonical",
                "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCollaboration/v1/chats/2/participants"
            }
        ]
    }
}

Back to Top