tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceSession APIsEnding Session

Ending Session

Modo Foco
Tamanho da Fonte
Última atualização: 2025-04-07 11:18:34

API Call Description

End a session that has been transferred to a human through this API.

Sample Request URL

https://console.tim.qq.com/v4/desk_http_svc/end_session?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please see REST API Introduction.
Parameter
Description
v4/desk_http_svc/end_session
Request API.
sdkappid
Assigned SDKAppID in the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Signature generated by the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of 0 to 4294967295.
contenttype
The request format has a fixed value of json.

Sample Request Packet

Specify SessionId to end session:
{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066"
}

Request Packet Fields

Field
Type
Required
Description
SessionId
String
Optional.
Specify the session ID to be ended.

Response Package Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}

Response Packet Fields

Field
Type
Description
ErrorCode
Integer
Error Code:
0 indicates success.
Non-zero indicates failure.
ErrorInfo
String
Error message.
ActionStatus
String
Result of request processing.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
141002
Internal error, please retry.
141004
Invalid parameter.
141005
Session does not exist or has completed.

API Debugging Tools

Debug this interface using the REST API online debugging tool.

References

Pull Single Chat History Messages (v4/openim/admin_getroammsg)
Anterior: Querying User Session StatusPróximo: Send Messages

Ajuda e Suporte

Esta página foi útil?

comentários