Close a Message Session

Request URL

POST {base_url}/{api_path}/message_session/close?access_token={access_token}

Request parameters


Parameter	Required	Type	Description
session_id	Yes	Integer	The unique ID of the message session. Note: You can query the message session ID using Search Specific Message Sessions.

Response parameters

Table 1.
Parameter	Type	Description
errcode	Integer	Returned error code. `0`: Succeed. Non-zero value: Failed. Note: You can check the error code and error message in Error Code and Error Message.
errmsg	String	Returned message. `SUCCESS`: Succeed. `FAILURE`: Failed.

Examples

Request example

Close a message session (ID: 3073).

POST /openapi/v1.0/message_session/close?access_token=xMv4MJAruG8wFiqj0f0y8tgaMvR44nQm HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
  "session_id": 3073
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}