# Get the client session state
Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide
Interface English name: getkfsession
This interface is used to obtain the current session state of a specified customer
# 1. How to call
# HTTPS calls
GET https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
# Cloud Calls
- This interface does not support cloud calls
# Third party invocation
This interface supports Third Party Platform generation business call.
This interface belongs to a permission set id of: 1,6,100-101
When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.
# 2. Request parameters
# Query parametersQuery String parameters
Parameter Name | type | Required to fill in | Example | Introductions |
---|---|---|---|---|
access_token | string | yes | ACCESS_TOKEN | Interface invocation credentials, using access_token , authorizer_access_token |
openid | string | yes | OPENID | Openid of fans |
# Request BodyRequest Payload
nothing
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
createtime | timestamp | Session Access Time |
kf_account | string | Reception customer service account |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
Example Requests
https://api.weixin.qq.com/customservice/kfsession/getsession?access_token=ACCESS_TOKEN&openid=OPENID
Return an example
{
"createtime": 123456789,
"kf_account": "test1@test"
}
# 6. Error code
The following is a list of error codes for this interface, other error codes can refer to General error codes
Error code | Error Description | Solutions |
---|---|---|
40003 | invalid openid | Invalid OpenID. Please confirm if the OpenID is following Official Account, or if it is another OpenID from the Official Account message template. |
65400 | please enable new custom service or wait for a while if you have enabled | The API is not available, that is, it has not opened / upgraded to the new customer service feature |
# 7. Scope of application
Official Account | Service Account |
---|---|
Certification only | Certification only |
- Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
- Other account types that are not expressly stated may not be called on this interface without special instructions;