Skip to content

apis.md

Latest commit

 

History

History
304 lines (222 loc) · 26.3 KB

apis.md

File metadata and controls

304 lines (222 loc) · 26.3 KB

全局声明

import "io"

Access token 获取

API calls

Name Request Type Response Type Access Token URL Doc
execGetAccessToken reqAccessToken respAccessToken - GET /cgi-bin/gettoken 获取access_token
execGetJSAPITicket reqJSAPITicket respJSAPITicket + GET /cgi-bin/get_jsapi_ticket 获取企业的jsapi_ticket
execGetJSAPITicketAgentConfig reqJSAPITicketAgentConfig respJSAPITicket + GET /cgi-bin/ticket/get 获取应用的jsapi_ticket
execJSCode2Session reqJSCode2Session respJSCode2Session + GET /cgi-bin/miniprogram/jscode2session 临时登录凭证校验code2Session
execAuthCode2UserInfo reqAuthCode2UserInfo respAuthCode2UserInfo + GET /cgi-bin/auth/getuserinfo 获取访问用户身份

成员管理

API calls

Name Request Type Response Type Access Token URL Doc
execUserCreate TODO TODO + POST /cgi-bin/user/create 创建成员
execUserGet reqUserGet respUserGet + GET /cgi-bin/user/get 读取成员
execUserUpdate reqUserUpdate respUserUpdate + POST /cgi-bin/user/update 更新成员
execUserDelete TODO TODO + GET /cgi-bin/user/delete 删除成员
execUserBatchDelete TODO TODO + POST /cgi-bin/user/batchdelete 批量删除成员
execUserSimpleList TODO TODO + GET /cgi-bin/user/simplelist 获取部门成员
execUserList reqUserList respUserList + GET /cgi-bin/user/list 获取部门成员详情
execConvertUserIDToOpenID reqConvertUserIDToOpenID respConvertUserIDToOpenID + POST /cgi-bin/user/convert_to_openid userid转openid
execConvertOpenIDToUserID reqConvertOpenIDToUserID respConvertOpenIDToUserID + POST /cgi-bin/user/convert_to_userid openid转userid
execUserAuthSucc TODO TODO + GET /cgi-bin/user/authsucc 二次验证
execUserBatchInvite TODO TODO + POST /cgi-bin/batch/invite 邀请成员
execUserJoinQrcode reqUserJoinQrcode respUserJoinQrcode + GET /cgi-bin/corp/get_join_qrcode 获取加入企业二维码
execUserIDByMobile reqUserIDByMobile respUserIDByMobile + POST /cgi-bin/user/getuserid 手机号获取userid
execUserIDByEmail reqUserIDByEmail respUserIDByEmail + POST /cgi-bin/user/get_userid_by_email 邮箱获取userid
execUserDetail reqUserDetail respUserDetail + POST //cgi-bin/user/getuserdetail 获取访问用户敏感信息

部门管理

API calls

Name Request Type Response Type Access Token URL Doc
execDeptCreate reqDeptCreate respDeptCreate + POST /cgi-bin/department/create 创建部门
execDeptUpdate TODO TODO + POST /cgi-bin/department/update 更新部门
execDeptDelete TODO TODO + GET /cgi-bin/department/delete 删除部门
execDeptList reqDeptList respDeptList + GET /cgi-bin/department/list 获取部门列表
execDeptSimpleList reqDeptSimpleList respDeptSimpleList + GET /cgi-bin/department/simplelist 获取子部门ID列表

标签管理

API calls

Name Request Type Response Type Access Token URL Doc
execTagCreate TODO TODO + POST /cgi-bin/tag/create 创建标签
execTagUpdate TODO TODO + POST /cgi-bin/tag/update 更新标签名字
execTagDelete TODO TODO + GET /cgi-bin/tag/delete 删除标签
execTagListUsers TODO TODO + GET /cgi-bin/tag/get 获取标签成员
execTagAddUsers TODO TODO + POST /cgi-bin/tag/addtagusers 增加标签成员
execTagDeleteUsers TODO TODO + POST /cgi-bin/tag/deltagusers 删除标签成员
execTagList TODO TODO + GET /cgi-bin/tag/list 获取标签列表

异步批量接口

API calls

Name Request Type Response Type Access Token URL Doc

身份验证

API calls

Name Request Type Response Type Access Token URL Doc
execUserInfoGet reqUserInfoGet respUserInfoGet + GET /cgi-bin/user/getuserinfo 获取访问用户身份

外部联系人管理 - 客户管理

API calls

Name Request Type Response Type Access Token URL Doc
execExternalContactList reqExternalContactList respExternalContactList + GET /cgi-bin/externalcontact/list 获取客户列表
execExternalContactGet reqExternalContactGet respExternalContactGet + GET /cgi-bin/externalcontact/get 获取客户详情
execExternalContactBatchList reqExternalContactBatchList respExternalContactBatchList + POST /cgi-bin/externalcontact/batch/get_by_user 批量获取客户详情
execExternalContactRemark reqExternalContactRemark respExternalContactRemark + POST /cgi-bin/externalcontact/remark 修改客户备注信息

外部联系人管理 - 获客助手

API calls

Name Request Type Response Type Access Token URL Doc
execExternalContactCustomerAcquisitionLinkList reqExternalContactCustomerAcquisitionLinkList respExternalContactCustomerAcquisitionLinkList + POST /cgi-bin/externalcontact/customer_acquisition/list_link 获取获客链接列表
execExternalContactCustomerAcquisitionInfo reqExternalContactCustomerAcquisitionInfo respExternalContactCustomerAcquisitionInfo + POST /cgi-bin/externalcontact/customer_acquisition/get 获取获客链接详情
execExternalContactCustomerAcquisitionCreate reqExternalContactCustomerAcquisitionCreate respExternalContactCustomerAcquisitionCreate + POST /cgi-bin/externalcontact/customer_acquisition/create_link 创建获客链接
execExternalContactCustomerAcquisitionCustomer reqExternalContactCustomerAcquisitionCustomer respExternalContactCustomerAcquisitionCustomer + POST /cgi-bin/externalcontact/customer_acquisition/customer 获取获客客户列表

外部联系人管理 - 客户标签管理

API calls

Name Request Type Response Type Access Token URL Doc
execExternalContactListCorpTags reqExternalContactListCorpTags respExternalContactListCorpTags + POST /cgi-bin/externalcontact/get_corp_tag_list 获取企业标签库
execExternalContactAddCorpTag reqExternalContactAddCorpTagGroup respExternalContactAddCorpTag + POST /cgi-bin/externalcontact/add_corp_tag 添加企业客户标签
execExternalContactEditCorpTag reqExternalContactEditCorpTag respExternalContactEditCorpTag + POST /cgi-bin/externalcontact/edit_corp_tag 编辑企业客户标签
execExternalContactDelCorpTag reqExternalContactDelCorpTag respExternalContactDelCorpTag + POST /cgi-bin/externalcontact/del_corp_tag 删除企业客户标签
execExternalContactMarkTag reqExternalContactMarkTag respExternalContactMarkTag + POST /cgi-bin/externalcontact/mark_tag 标记客户企业标签

外部联系人管理 - 客户分配

API calls

Name Request Type Response Type Access Token URL Doc
execListUnassignedExternalContact reqListUnassignedExternalContact respListUnassignedExternalContact + POST /cgi-bin/externalcontact/get_unassigned_list 获取离职成员的客户列表
execTransferExternalContact reqTransferExternalContact respTransferExternalContact + POST /cgi-bin/externalcontact/transfer 分配成员的客户
execGetTransferExternalContactResult reqGetTransferExternalContactResult respGetTransferExternalContactResult + POST /cgi-bin/externalcontact/get_transfer_result 查询客户接替结果
execTransferGroupChatExternalContact reqTransferGroupChatExternalContact respTransferGroupChatExternalContact + POST /cgi-bin/externalcontact/groupchat/transfer 离职成员的群再分配

应用管理

API calls

Name Request Type Response Type Access Token URL Doc
execAgentGet reqAgentGet respAgentGet + GET /cgi-bin/agent/get 获取指定的应用详情
execAgentList reqAgentList respAgentList + GET /cgi-bin/agent/list 获取access_token对应的应用列表
execAgentSet TODO TODO + POST /cgi-bin/agent/set 设置应用

应用管理 - 自定义菜单

API calls

Name Request Type Response Type Access Token URL Doc
execMenuCreate TODO TODO + POST /cgi-bin/menu/create 创建菜单
execMenuGet TODO TODO + GET /cgi-bin/menu/get 获取菜单
execMenuDelete TODO TODO + GET /cgi-bin/menu/delete 删除菜单

消息推送

API calls

Name Request Type Response Type Access Token URL Doc
execAppchatCreate reqAppchatCreate respAppchatCreate + POST /cgi-bin/appchat/create 创建群聊会话
execAppchatUpdate reqAppchatUpdate respAppchatUpdate + POST /cgi-bin/appchat/update 修改群聊会话
execAppchatGet reqAppchatGet respAppchatGet + GET /cgi-bin/appchat/get 获取群聊会话
execMessageSend reqMessage respMessageSend + POST /cgi-bin/message/send 发送应用消息
execAppchatSend reqMessage respMessageSend + POST /cgi-bin/appchat/send 应用推送消息

素材管理

API calls

Name Request Type Response Type Access Token URL Doc
execMediaUpload reqMediaUpload respMediaUpload + POST(media) /cgi-bin/media/upload 上传临时素材
execMediaUploadImg reqMediaUploadImg respMediaUploadImg + POST(media) /cgi-bin/media/uploadimg 上传永久图片
execMediaGet reqMediaGet io.ReadCloser + GET(binary) /cgi-bin/media/get 获取临时素材
execMediaGetJSSDK TODO TODO + GET /cgi-bin/media/get/jssdk 获取高清语音素材

OA 数据接口

API calls

Name Request Type Response Type Access Token URL Doc
execOAGetTemplateDetail reqOAGetTemplateDetail respOAGetTemplateDetail + POST /cgi-bin/oa/gettemplatedetail 获取审批模板详情
execOAApplyEvent reqOAApplyEvent respOAApplyEvent + POST /cgi-bin/oa/applyevent 提交审批申请
execOAGetApprovalInfo reqOAGetApprovalInfo respOAGetApprovalInfo + POST /cgi-bin/oa/getapprovalinfo 批量获取审批单号
execOAGetApprovalDetail reqOAGetApprovalDetail respOAGetApprovalDetail + POST /cgi-bin/oa/getapprovaldetail 获取审批申请详情
execOAGetCorpVacationConf reqOAGetCorpVacationConf respOAGetCorpVacationConf + GET /cgi-bin/oa/vacation/getcorpconf 获取企业假期管理配置
execOAGetUserVacationQuota reqOAGetUserVacationQuota respOAGetUserVacationQuota + POST /cgi-bin/oa/vacation/getuservacationquota 获取成员假期余额
execOASetOneUserVacationQuota reqOASetOneUserVacationQuota respOASetOneUserVacationQuota + POST /cgi-bin/oa/vacation/setoneuserquota 修改成员假期余额

企业支付

API calls

Name Request Type Response Type Access Token URL Doc

电子发票

API calls

Name Request Type Response Type Access Token URL Doc

会话内容存档

API calls

Name Request Type Response Type Access Token URL Doc
execMsgAuditListPermitUser reqMsgAuditListPermitUser respMsgAuditListPermitUser + POST /cgi-bin/msgaudit/get_permit_user_list 获取会话内容存档开启成员列表
execMsgAuditCheckSingleAgree reqMsgAuditCheckSingleAgree respMsgAuditCheckSingleAgree + POST /cgi-bin/msgaudit/check_single_agree 获取会话同意情况（单聊）
execMsgAuditCheckRoomAgree reqMsgAuditCheckRoomAgree respMsgAuditCheckRoomAgree + POST /cgi-bin/msgaudit/check_room_agree 获取会话同意情况（群聊）
execMsgAuditGetGroupChat reqMsgAuditGetGroupChat respMsgAuditGetGroupChat + POST /cgi-bin/msgaudit/groupchat/get 获取会话内容存档内部群信息

企业服务人员管理 - 联系我与客户入群方式

API calls

Name Request Type Response Type Access Token URL Doc
execListFollowUserExternalContact reqListFollowUserExternalContact respListFollowUserExternalContact + GET /cgi-bin/externalcontact/get_follow_user_list 获取配置了客户联系功能的成员列表
execAddContactExternalContact reqAddContactExternalContact respAddContactExternalContact + POST /cgi-bin/externalcontact/add_contact_way 配置客户联系「联系我」方式
execGetContactWayExternalContact reqGetContactWayExternalContact respGetContactWayExternalContact + POST /cgi-bin/externalcontact/get_contact_way 获取企业已配置的「联系我」方式
execListContactWayChatExternalContact reqListContactWayExternalContact respListContactWayChatExternalContact + POST /cgi-bin/externalcontact/list_contact_way 获取企业已配置的「联系我」列表
execUpdateContactWayExternalContact reqUpdateContactWayExternalContact respUpdateContactWayExternalContact + POST /cgi-bin/externalcontact/update_contact_way 更新企业已配置的「联系我」成员配置
execDelContactWayExternalContact reqDelContactWayExternalContact respDelContactWayExternalContact + POST /cgi-bin/externalcontact/del_contact_way 删除企业已配置的「联系我」方式
execCloseTempChatExternalContact reqCloseTempChatExternalContact respCloseTempChatExternalContact + POST /cgi-bin/externalcontact/close_temp_chat 结束临时会话
execAddGroupChatJoinWayExternalContact reqAddGroupChatJoinWayExternalContact respAddGroupChatJoinWayExternalContact + POST /cgi-bin/externalcontact/groupchat/add_join_way 配置客户群「加入群聊」方式
execGetGroupChatJoinWayExternalContact reqGetGroupChatJoinWayExternalContact respGetGroupChatJoinWayExternalContact + POST /cgi-bin/externalcontact/groupchat/get_join_way 获取企业已配置的客户群「加入群聊」方式
execUpdateGroupChatJoinWayExternalContact reqUpdateGroupChatJoinWayExternalContact respUpdateGroupChatJoinWayExternalContact + POST /cgi-bin/externalcontact/groupchat/update_join_way 更新企业已配置的客户群「加入群聊」方式
execDelGroupChatJoinWayExternalContact reqDelGroupChatJoinWayExternalContact respDelGroupChatJoinWayExternalContact + POST /cgi-bin/externalcontact/groupchat/del_join_way 删除企业已配置的客户群「加入群聊」方式

客户联系 - 客户群管理

API calls

Name Request Type Response Type Access Token URL Doc
execGroupChatListGet reqGroupChatList respGroupChatList + POST /cgi-bin/externalcontact/groupchat/list 获取客户群列表
execGroupChatInfoGet reqGroupChatInfo respGroupChatInfo + POST /cgi-bin/externalcontact/groupchat/get 获取客户群详细
execConvertOpenGIDToChatID reqConvertOpenGIDToChatID respConvertOpenGIDToChatID + POST /cgi-bin/externalcontact/opengid_to_chatid 客户群opengid转换

在职继承

API calls

Name Request Type Response Type Access Token URL Doc
execTransferCustomer reqTransferCustomer respTransferCustomer + POST /cgi-bin/externalcontact/transfer_customer 在职继承 分配在职成员的客户
execGetTransferCustomerResult reqGetTransferCustomerResult respGetTransferCustomerResult + POST /cgi-bin/externalcontact/transfer_result 在职继承 查询客户接替状态

离职继承

API calls

Name Request Type Response Type Access Token URL Doc
execTransferResignedCustomer reqTransferCustomer respTransferCustomer + POST /cgi-bin/externalcontact/resigned/transfer_customer 离职继承 分配离职成员的客户
execGetTransferResignedCustomerResult reqGetTransferCustomerResult respGetTransferCustomerResult + POST /cgi-bin/externalcontact/resigned/transfer_result 离职继承 查询客户接替状态

客户联系 - 消息推送

API calls

Name Request Type Response Type Access Token URL Doc
execAddMsgTemplate reqAddMsgTemplateExternalContact respAddMsgTemplateExternalContact + POST /cgi-bin/externalcontact/add_msg_template 创建企业群发
execSendWelcomeMsg reqSendWelcomeMsgExternalContact respSendWelcomeMsgExternalContact + POST /cgi-bin/externalcontact/send_welcome_msg 发送新客户欢迎语

微信客服 - 客服账号管理

API calls

Name Request Type Response Type Access Token URL Doc
execKfAccountCreate reqKfAccountCreate respKfAccountCreate + POST /cgi-bin/kf/account/add 添加客服账号
execKfAccountUpdate reqKfAccountUpdate respKfAccountUpdate + POST /cgi-bin/kf/account/update 修改客服账号
execKfAccountDelete reqKfAccountDelete respKfAccountDelete + POST /cgi-bin/kf/account/del 删除客服账号
execKfAccountList reqKfAccountList respKfAccountList + GET /cgi-bin/kf/account/list 获取客服账号列表
execAddKfContact reqAddKfContact respAddKfContact + POST /cgi-bin/kf/add_contact_way 获取客服账号链接

微信客服 - 接待人员管理

API calls

Name Request Type Response Type Access Token URL Doc
execKfServicerCreate reqKfServicerCreate respKfServicerCreate + POST /cgi-bin/kf/servicer/add 添加接待人员
execKfServicerDelete reqKfServicerDelete respKfServicerDelete + POST /cgi-bin/kf/servicer/del 删除接待人员
execKfServicerList reqKfServicerList respKfServicerList + GET /cgi-bin/kf/servicer/list 获取接待人员列表

微信客服 - 会话分配与消息收发

API calls

Name Request Type Response Type Access Token URL Doc
execKfServiceStateGet reqKfServiceStateGet respKfServiceStateGet + POST /cgi-bin/kf/service_state/get 获取会话状态
execKfServiceStateTrans reqKfServiceStateTrans respKfServiceStateTrans + POST /cgi-bin/kf/service_state/trans 变更会话状态
execKfSyncMsg reqKfSyncMsg respKfSyncMsg + POST /cgi-bin/kf/sync_msg 读取消息
execKfSend reqMessage respMessageSend + POST /cgi-bin/kf/send_msg 发送消息
execKfOnEventSend reqMessage respMessageSend + POST /cgi-bin/kf/send_msg_on_event 发送欢迎语等事件响应消息

微信客服 - 其他基础信息获取

API calls

Name Request Type Response Type Access Token URL Doc
execKfCustomerBatchGet reqKfCustomerBatchGet respKfCustomerBatchGet + POST /cgi-bin/kf/customer/batchget 获取客户基础信息