# Get an online customer service list

Debugging Tools

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 name: getonlinekflist

This interface is used to obtain current online customer service lists

# 1. How to call

# HTTPS calls

GET https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist?access_token=ACCESS_TOKEN

# Cloud Calls

This interface does not support cloud calls

# Third party invocation

This interface supports Third Party Platform generation business call.
The permissions set to which the interface belongs are: 1, 6, 19, 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 parameters`Query String parameters`

Parameter Name	type	Required to fill in	Introductions
access_token	string	yes	Interface invocation credentials, using access_token , authorizer_access_token

# Request Body`Request Payload`

nothing

# 3. Return Parameters

# `Response Payload`

Parameter Name	type	Introductions
kf_online_list	objarray	Online customer service list

# Res.kf_online_list(Array)`Object Payload`

Online customer service list

Parameter Name	type	Introductions
kf_account	string	Complete customer service account, format: account prefix @ Official Account WeChat
status	number	Customer service online status, currently: 0-not online, 1-web online
kf_id	number	Customer Service Number
accepted_case	number	Number of sessions currently being received by customer service

# 4. Note

There are no special considerations for this interface

# 5. Code examples

Example Requests

https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist

Return an example

{
  "kf_online_list": [{
      "kf_account": ""
  }]
}

# 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
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

How this interface can be invoked under different account types:

Weixin Mini Program	Official Account	Service Account	MiniGame
✔	Certification only	Certification only	✔

✔: The account can call this interface
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;