# Get a list of customer service sessions
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: getkfsessionlist
This interface is used to obtain a list of current sessions for specified customer service
# 1. How to call
# HTTPS calls
GET https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KF_ACCOUNT
# 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 |
kf_account | string | yes | test1@test | Full customer service account |
# Request BodyRequest Payload
nothing
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
sessionlist | objarray | List of sessions |
# Res.sessionlist(Array)Object Payload
List of sessions
Parameter Name | type | Introductions |
---|---|---|
createtime | timestamp | Session Access Time |
openid | string | User openid |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
Example Requests
https://api.weixin.qq.com/customservice/kfsession/getsessionlist?access_token=ACCESS_TOKEN&kf_account=KFACCOUNT
Return an example
{
"sessionlist": [
{
"createtime": 123456789,
"openid": "OPENID"
}
]
}
# 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 |
---|---|---|
0 | Ok or in a normal state | OK means to go from abnormal to normal in a normal state |
65401 | invalid custom service account | An invalid customer service account |
65402 | the custom service account need to bind a wechat user | Customer service account has not been bound WeChat number, can not be put into use |
# 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;