1. Teleboard | Support Center
  2. Solution home
  3. API Documentation
  4. REST API - PUT Requests
Open navigation

PUT/myStatus

Function


Use the PUT/myStatus (case sensitive) method to set your TeleConsole's availability status - specifying both the type and message of the status.


Parameters


There are no parameters in the header. All parameters go in the body in JSON Raw format.


ParameterTypeOperation
*statusBooleanThe type of status to be set:

Use a value of 1 to set status to available - 

Use a value of 0 to set status to unavailable - 
status_msgstringSelect either an existing status message to be set (not case sensitive) or specify a new one.

*If you don't specify a status field in the request an unavailable status will be used as a default choice.


If using the web version of the TeleConsle, please refresh your browser to see the change in avaiilability status.


Example


To set the Teleconsole's "unavailable" status type with a newly created status message of "Back in office in 2 hours" use this syntax:


HTTPS method: PUT


Header


webserv.telebroad.com/api/teleconsole/rest/myStatus


Body


{"status":"0", "status_msg":"Back in office in 2 hours"}


Response:


A "true" response will be returned for a successful change of status:


{

    "error": null,

    "result": "true"

}

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article