Status of the chat gateway


This request returns the external chat gateway status ("online" or "offline"). If the status is offline, the chat messages are not delivered and no agent is available to answer.

Resource

GET https://<HOST>/portal/chat/<TENANT>/gateways/<GATEWAY_ID>/status

Where 'GATEWAY_ID' is the id of the gateway.

Parameters

None

Payload

None

Response

Object Response < string >

Context

Authorization

Authorized by token:
The Xelion token should be send in the Authorization header.

Errors

HTTP code Description

400

Missing tenant, gateway id

500

General error, gateway not found

Example

Request
GET https://xelion.nl/portal/chat/master/gateways/1234567/status
Response
{
    "value": "online"
}