Get
/api/v1/livechat/inquiries.getOne
Permission required: view-l-room
Changelog
| Version | Description |
|---|---|
| 2.4.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
roomId
stringRequired
The room ID.
Responses
200
OK
Success Example
{
"inquiry": {
"_id": "6560940c6a1ef5b1a2bf9324",
"rid": "yy8SmYKfHQ6GZdnJp",
"name": "kookie",
"ts": "2023-11-24T12:16:12.370Z",
"message": "",
"status": "taken",
"v": {
"_id": "656090576a1ef5b1a2bf919b",
"username": "guest-51",
"token": "38cc8c765bf77e943f6e4319c5891f6c04",
"status": "online",
"activity": [
"2023-11"
]
},
"t": "l",
"priorityWeight": 99,
"estimatedWaitingTimeQueue": 9999999,
"source": {
"type": "widget"
},
"_updatedAt": "2023-11-24T12:27:43.852Z",
"lastMessage": {
"_id": "Hjwmd7bBZTiEXrywn",
"rid": "yy8SmYKfHQ6GZdnJp",
"msg": "hello",
"ts": "2023-11-24T12:27:43.474Z",
"u": {
"_id": "CkCPNcvsvCDfmWLqC",
"username": "test.cat",
"name": "testCat"
},
"_updatedAt": "2023-11-24T12:27:43.820Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "hello"
}
]
}
]
},
"takenAt": "2023-11-24T12:18:19.012Z"
},
"success": true
}object
inquiry
object
_id
string
rid
string
name
string
ts
string
message
string
status
string
v
object
_id
string
username
string
token
string
status
string
activity
Array of string
string
t
string
priorityWeight
integer
estimatedWaitingTimeQueue
integer
source
object
type
string
_updatedAt
string
lastMessage
object
_id
string
rid
string
msg
string
ts
string
u
object
_id
string
username
string
name
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
takenAt
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'roomId' [invalid-params]",
"errorType": "invalid-params"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
403
Forbidden
Permission Error
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Unauthorized
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string