Reference

Chatroom

The chatroom object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this chatroom
Active: bool optional
BusinessId: Id required
LastAgentVisit: DateTime? optional
Name: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this chatroom
SystemId: string optional api-only
User defined data about this chatroom. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "LastAgentVisit": ,
  "Name": "Name",
  "UniqueId": "d6017011-36a4-4fb7-9aff-aaafdd3aac45",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ChatRoom

This endpoint allows you to GET a list of chatrooms based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/support/chatrooms?...

πŸ”’ Requires role "ChatRoom-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search chatroom records based on their different properties.
Id number
?Id=12345678
ChatRoom_Active bool
?ChatRoom_Active=...
ChatRoom_Business Business
?ChatRoom_Business=...
ChatRoom_LastAgentVisit DateTime?
?ChatRoom_LastAgentVisit=...
ChatRoom_Name string
?ChatRoom_Name=...
ChatRoom_Users List of User
?ChatRoom_Users=...

Range search querystring parameters
Lets you search chatroom records based on a range of date or numeric values.
To_ChatRoom_CreatedOn date
?To_ChatRoom_CreatedOn=2010-01-01T20:32
From_ChatRoom_CreatedOn date
?From_ChatRoom_CreatedOn=2010-01-01T20:32
To_ChatRoom_UpdatedOn date
?To_ChatRoom_UpdatedOn=2010-01-01T20:32
From_ChatRoom_UpdatedOn date
?From_ChatRoom_UpdatedOn=2010-01-01T20:32
To_ChatRoom_LastAgentVisit date
?To_ChatRoom_LastAgentVisit=2010-01-01T20:32
From_ChatRoom_LastAgentVisit date
?From_ChatRoom_LastAgentVisit=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/support/chatrooms?ChatRoom_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Active": false,
        "LastAgentVisit": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "300e4d5f-090e-4c94-9214-e516f976d063",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find ChatRooms by IDs

Gets one or more chatroom records based on their Id.
GET https://spaces.nexudus.com/api/support/chatrooms?ChatRoom_Id=[:id1,:id2,...]

πŸ”’ Requires role "ChatRoom-List"

Querystring parameters
ChatRoom_Id: array requried
?ChatRoom_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/support/chatrooms?ChatRoom_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Active": false,
        "LastAgentVisit": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "179e5853-f8b5-449c-be28-3f3ba10a977d",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single ChatRoom by Id

Gets one chatroom record by its Id.
GET https://spaces.nexudus.com/api/support/chatrooms/:Id

πŸ”’ Requires role "ChatRoom-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/support/chatrooms/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "LastAgentVisit": ,
  "Name": "Name",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "cbd076ef-2691-465b-95f6-058a43f0158a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ChatRoom

Creates a new chatroom.
POST https://spaces.nexudus.com/api/support/chatrooms

πŸ”’ Requires role "ChatRoom-Create"

Body parameters
BusinessId: number required
Name: string optional
Active: bool optional
LastAgentVisit: DateTime? optional

Example request

POST https://spaces.nexudus.com/api/support/chatrooms
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "Name": "Name",
    "Active": false,
    "LastAgentVisit": ,
    "Users": [12345678, 87654321],
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update ChatRoom

Updates an existing chatroom.
PUT https://spaces.nexudus.com/api/support/chatrooms

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "ChatRoom-Edit"

Body parameters
Id: number required
The unique Id of the chatroom to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Active: bool cleared if missing
LastAgentVisit: DateTime? cleared if missing

Example request

PUT https://spaces.nexudus.com/api/support/chatrooms
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Active": false,
    "LastAgentVisit": ,
    "Users": [12345678, 87654321],
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete ChatRoom

Deletes an existing chatroom by its Id.
DELETE https://spaces.nexudus.com/api/support/chatrooms/:Id

πŸ”’ Requires role "ChatRoom-Delete"

URL parameters
Id: number required
The unique Id of the chatroom to update.

Example request

DELETE https://spaces.nexudus.com/api/support/chatrooms/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more chatroom records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for chatroom records.
GET https://spaces.nexudus.com/api/support/chatrooms/commands

Example request

GET https://spaces.nexudus.com/api/support/chatrooms/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more chatroom record IDs.
POST https://spaces.nexudus.com/api/support/chatrooms/runacommand
πŸ”’ Requires role "ChatRoom-Edit"

Example request

POST https://spaces.nexudus.com/api/support/chatrooms/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.