# Create a session

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: createkfsession

This interface is used to create a session between customer service and users.

Note: The specified customer service account must be tied to WeChat number and online

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/customservice/kfsession/create?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.

  • 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 NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
kf_accountstringyestest1@testComplete customer service account, format: account prefix @ Official Account WeChat
openidstringyesOPENIDOpenid of fans

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
errcodenumberReturn code
errmsgstringError message

# 4. Note

There are no special considerations for this interface

# 5. Code examples

Example Requests

{
  "kf_account": "test1@test",
  "openid": "OPENID"
}

Return an example

{
  "errcode": 0,
  "errmsg": "ok"
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
0oksuccess
65400please enable new custom service or wait for a while if you have enabledNo customer service functions were opened / upgraded to the new version
65401invalid custom service accountAn invalid customer service account
65402the custom service account need to bind a wechat userThe WeChat number has not yet been bound
65415the worker is not onlineThe designated customer service is not online

# 7. Scope of application

How this interface can be invoked under different account types:
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;