REST API: Set Online Chat Status

Anonymous User

Published: 1/5/2019

Grace Kamau

Updated: 8/31/2020

0 (0votes)

Set Online Chat Status

Set your chat status. Valid for Communifire version 6.0 and above.

HTTP Method

PUT

Response Format

JSON

Requires Authentication?

YES

Product Version

6.0 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
Chat JSON	Used in the request body	This is JSON that represents a chat object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
onlinechatstatus	Used in the request body	This will set your online chat status. Online = 1 Offline = 2 Invisible = 3 Do Not Disturb = 4 Away = 5

{
  "onlinechatStatus":"2"
}

Here is an example of JSON data returned from the API call.

{
   "IsError": false,
   "ResponseMessage": "",
   "ResponseData": "status-offline"
}

Please Note Your content type that you pass in the header of your request should be 'application/json'.