Create or Get Call Center Room
- Print
- DarkLight
- PDF
Create or Get Call Center Room
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/voip/room
Creates a VoIP room if the room ID is not passed; otherwise, it gets an existing room based on the room ID and token.
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
token
stringRequired
The visitor token.
Example867ad6a09fc4af29f6f1f2a9cf1deaba
agentId
stringRequired
The agent ID.
Example6vHSSqdBHdm2
rid
string
The room ID. If the room ID is not provided, a new room is created. If the room ID is provided, the room's details are returned, if the room exists.
Examplejiuriewcnm2R4gfi
direction
string
The direction of the call, inbound or outbound.
Exampleinbound
Responses
200
OK
Success Example
{
"room": {
"_id": "kCJDd5peKiZnGJLPq",
"fname": "Mary",
"t": "l",
"v": {
"_id": "47Dajwh9DjpnTAugW",
"username": "guest-165",
"token": "8s7e9ony6ctl27e1qf8kue",
"status": "offline",
"lastMessageTs": "2021-07-09T20:20:58.755Z"
},
"departmentId": "CAJioQNAvLnYWTy8i",
"default": false,
"ro": false,
"sysMes": true,
"open": true,
"msgs": 7,
"ts": "2021-07-09T20:12:19.795Z",
"_updatedAt": "2021-07-09T20:21:07.334Z",
"lm": "2021-07-09T20:20:58.755Z",
"customFields": {
"salesforceCrmContactId": "0032y000009mtOIAAY"
},
"usersCount": 2,
"cl": false,
"departmentAncestors": [
"sriw2wmP2Zz2pPrre"
],
"lastMessage": {
"_id": "SgrsSm3HNGrG5xTmk",
"rid": "kCJDd5peKiZnGJLPq",
"msg": "d",
"token": "8s7e9ony6ctl27e1qf8kue",
"alias": "Mary",
"ts": "2021-07-09T20:20:58.755Z",
"u": {
"_id": "47Dajwh9DjpnTAugW",
"username": "guest-165",
"name": "Mary"
},
"_updatedAt": "2021-07-09T20:20:58.896Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "d"
}
]
}
],
"newRoom": false,
"showConnecting": true
},
"metrics": {
"reaction": {
"fd": "2021-07-09T20:19:53.243Z",
"ft": 23.821,
"tt": 24.006
},
"response": {
"avg": 226.4365,
"fd": "2021-07-09T20:19:53.243Z",
"ft": 452.688,
"total": 2,
"tt": 452.873
},
"v": {
"lq": "2021-07-09T20:20:58.755Z"
},
"servedBy": {
"lr": "2021-07-09T20:19:53.077Z"
}
},
"servedBy": {
"_id": "XycfA5CetCPuEjqxw",
"username": "kim.jane",
"ts": "2021-07-09T20:19:29.422Z"
},
"waitingResponse": true
},
"newRoom": false,
"success": true
}object
room
object
_id
string
fname
string
t
string
v
object
_id
string
username
string
token
string
status
string
lastMessageTs
string
departmentId
string
default
boolean
ro
boolean
sysMes
boolean
open
boolean
msgs
integer
ts
string
_updatedAt
string
lm
string
customFields
object
salesforceCrmContactId
string
usersCount
integer
cl
boolean
departmentAncestors
Array of string
string
lastMessage
object
_id
string
rid
string
msg
string
token
string
alias
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
newRoom
boolean
showConnecting
boolean
metrics
object
reaction
object
fd
string
ft
number
tt
number
response
object
avg
number
fd
string
ft
number
total
integer
tt
number
v
object
lq
string
servedBy
object
lr
string
servedBy
object
_id
string
username
string
ts
string
waitingResponse
boolean
newRoom
boolean
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "must have required property 'token'\n must have required property 'rid'\n must match exactly one schema in oneOf [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
Example 1
{
"success": false,
"error": "User does not have the permissions required for this action [error-unauthorized]"
}Example 2
{
"success": false,
"error": "unauthorized"
}object
success
boolean
error
string
Was this article helpful?