Inquiries List

Lists all of the open livechat inquiries. It supports the Offset, Count, and Sort Query Parameters.

URL

Requires Auth

HTTP Method

/api/v1/livechat/inquiries.list

yes

GET

Query Parameters

Argument

Example

Required

Description

department

ByehQjC44FwMeiLbX

Optional

The department's id or name

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
http://localhost:3000/api/v1/livechat/inquiries.list

Example Result

{
"inquiries": [
{
"_id": "GpxfRo8TaPHfsnnC5",
"rid": "EbQjtCosHJWLQmQYT",
"name": "Marcos Defendi",
"ts": "2019-06-11T19:01:57.424Z",
"department": "jHFgdJyJWstB9M2ik",
"status": "open"
},
{
"_id": "9dCi64GkwWE389xCm",
"rid": "ZpjCcbRwPPdnhKWW5",
"name": "Marcos Defendi",
"ts": "2019-06-11T19:00:43.124Z",
"department": "gDDAjeJb7BhHzzEQ8",
"status": "open"
}
],
"offset": 0,
"count": 1,
"total": 1,
"success": true
}

Change Log

Version

Description

1.2.0

Added

Livechat take inquiry

Takes an open inquiry.

URL

Requires Auth

HTTP Method

/api/v1/livechat/inquiries.take

yes

POST

Payload

Argument

Example

Required

Description

inquiryId

ByehQjC44FwMeiLbX

Required

The inquiry's id

userId

ByehQjCfsd876sfd

Optional

The user's (agent) id to take the inquiry.

Note: if the user id is provided, the user must have the view-l-room permission.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
http://localhost:3000/api/v1/livechat/inquiries.take \
-d '{ "inquiryId": "ByehQjC44FwMeiLbX" }'

Example Result

{
"inquiry": {
"_id": "wbKmn6pAZ8jyJuANG",
"rid": "S4wwL9WNY98uoHgJg",
"message": "test",
"name": "teste",
"ts": "2019-06-10T23:09:06.482Z",
"agents": [
"hjwGZafNqExtFNmN7",
"26KdXgrQXhddy2MfQ"
],
"status": "open",
"v": {
"_id": "2iZSexGXjW7EJnRwM",
"username": "guest-3",
"token": "RtQzkfQYKG4WpNMEW",
"status": "online"
},
"t": "l",
"_updatedAt": "2019-06-10T23:09:07.480Z"
},
"success": true
}

Change Log

Version

Description

1.2.0

Added

Livechat Get one inquiry by room id

Get one inquiry by room id.

URL

Requires Auth

HTTP Method

/api/v1/livechat/inquiries.getOne

yes

POST

Query Parameters

Argument

Example

Required

Description

roomId

ByehQjC44FwMeiLbX

Required

The room's id

Note: if the user id is provided, the user must have the view-l-room permission.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
-H "Content-type: application/json" \
http://localhost:3000/api/v1/livechat/inquiries.getOne?roomId=ByehQjC44FwMeiLbX

Example Result

{
"inquiry": {
"_id": "EMXtMA7mPPNkQtWWq",
"rid": "MA6HRhkEdRGATfEbh",
"name": "inquiry test",
"ts": "2019-12-13T18:54:25.352Z",
"message": "",
"status": "queued",
"v": {
"_id": "rLitbjv7e9WyLBCR4",
"username": "guest-14",
"token": "btzu0qdm0sjsn7aqm78kzr",
"status": "offline"
},
"t": "l",
"_updatedAt": "2019-12-13T19:33:13.255Z"
},
"success": true
}

Change Log

Version

Description

2.4.0

Added