tencent cloud

Cloud Contact Center

Announcement
What's New
Cloud Contact Center Terminology Update
What is Tencent Cloud Contact Center
Overview
Feature List
Terms Introduction
Handling Firewall Restrictions
AI Voicebot
Billing Guide
Voice Call Billing Overview
Desk Billing Overview
View Billing
Refund Policy
New User Guide
Voice Guide
Desk Guide
Use Case
Inbound: Customer Experience
Outbound: Telemarketing
Auto Dialer: Voice Notification
Integration Use Case (SDK）
Administrator Guide
Voice Guide
Desk Guide
Member Guide
Voice Guide
Desk Guide
AI Voice Agent Guide
Introducing AI Voice Agent
AI Voice Agent Practical Tutorial
Set Up Your AI Voice Agent
Activate AI Voice Agent Call
AI Voice Agent Call Logs
Developer Guide
SDK Development Guide
Data Push
Voice API Reference
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Desk API Reference
API Reference
Callback Configuration
FAQs
Data Deletion Guide
Legal
Privacy Policy
Data Processing And Security Agreement
Service Level Agreements
TENCENT CLOUD CONTACT CENTRE TERMS OF USE
Glossary
Contact Us
DokumentasiCloud Contact CenterDesk API ReferenceAPI ReferenceSession APIsQuerying User Session Status

Querying User Session Status

Mode fokus
Ukuran font
Terakhir diperbarui: 2025-04-07 11:16:11

API Call Description

Query the status of user sessions through this API.

Sample Request URL

https://console.tim.qq.com/v4/desk_http_svc/get_session_state?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/get_session_state
Request API.
sdkappid
Assigned SDKAppID in the Chat console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Generated signature of the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer. The value ranges from 0 to 4294967295.
contenttype
The request format has a fixed value of json.

Sample Request Packet

Specify SessionId for inquiry (applicable to all users in client integration method)
{
    "SessionId": "b0f4ca12-4850-4218-a284-efe679a87066"
}
Query UserId for designated users and customer service accounts (applicable only to user-end integration method of "application/client")
{
    "ClientUserId":"user1",
    "CustomerServiceId":"@customer_service_account"
}

Request Packet Fields

Field
Type
Required
Description
SessionId
String
Optional.
Specify the conversation ID to be queried.
ClientUserId
String
Optional.
User ID of the user.
CustomerServiceId
String
Optional.
UserID of the customer service account.

Response Packet Body Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "SessionId": "a-b-c-d-e",
    "CurrentState": "Agent",
    "AgentId": "test@qq.com"
}


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.
SessionId
String
Session ID.
CurrentState
String
Current status of the session, valid values may include:
Not in session
Chatbot: Chatbot reception in progress.
WaitingForAgentAnswering: Wait for customer service confirmation and reception.
Queuing: Being queued for manual service.
Agent: Manual service in progress.
AgentId
String
When the status is WaitingForAgentAnswering or Agent, this field represents the account of the human customer service for reception. This field is empty in other statuses.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 200. The actual error code and error information are represented 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, retry.
141004
Invalid parameter.
141005
Session does not exist or has ended.

API Debugging Tools

Debug this interface using the REST API online debugging tool.

References

Pull Single Chat History Messages (v4/openim/admin_getroammsg)
Topik sebelumnya: Query Session RecordsTopik selanjutnya: Ending Session

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan