Get Omnichannel Contact
- Print
- DarkLight
- PDF
Get Omnichannel Contact
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/omnichannel/contact
Retrieve a contact's information. Permission required: view-l-room
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
contactId
stringRequired
The contact ID.
Responses
200
OK
Success Example
{
"contact": {
"_id": "653f9ce1a2f73c7460e18e82",
"username": "guest-39",
"ts": "2023-10-30T12:09:05.982Z",
"token": "434lxd7iss8yh8c4m80wh",
"_updatedAt": "2023-10-30T13:43:22.044Z",
"contactManager": {
"username": "kim.jane"
},
"livechatData": {},
"name": "Chris",
"phone": [
{
"phoneNumber": "+91123456788"
}
],
"visitorEmails": [
{
"address": "[email protected]"
}
]
},
"success": true
}object
contact
object
_id
string
username
string
ts
string
token
string
_updatedAt
string
contactManager
object
username
string
livechatData
object
name
string
phone
Array of object
object
phoneNumber
string
visitorEmails
Array of object
object
address
string
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "Match error: Missing key 'contactId'"
}object
success
boolean
error
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?