Delete a Message Session

Delete a message session.

Request URL

GET {base_url}/{api_path}/message_session/delete?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.
user_type Yes Integer The type of the operator who deletes the message session.
Valid value:
  • 1: Extension user.
  • 9: Third-party message analytics platform.
user_no No String The unique ID of the operator who deletes the message session.
Valid value:
  • If user_type is set to 1, this parameter is REQUIRED and is used to specify the corresponding ID of the extension user.
    Note: You can query the extension ID using Search Specific Extensions.
  • If user_type is set to 9, set the value to api or leave it empty.

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

Delete a message session (ID: 3074) for extension 1003.

GET /openapi/v1.0/message_session/delete?user_type=1&user_no=1003&session_id=3074&access_token=o9wi8YLOEMWhCHjdpDO0QNX0AO9ALKxR HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

Response example

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