企业微信机器人服务
  • 167
  • 23587

企微机器人

企业微信机器人服务会员免费已下线
  • 该接口普通会员每天赠送100次调用额度
  • 高级会员1万次/天黄金会员50万次/天
该接口可接入企业微信应用,使其拥有天行智能机器人回复能力,可开启或关闭机器人三十多项能力。使用本接口前,请在控制台-微信管理-企业微信设置中设置企业ID、应用Token等信息。如需查询和漫游机器人聊天记录可使用机器人日志接口。

因企业微信最新政策要求,新增或修改应用消息服务器配置,消息验证URL的所属域名备案主体必须与客户企业主体相同,因此第三方填写本接口地址将无法通过企微验证。详见企业微信公告:企业内部开发配置域名指引,如有相关需求,可联系客服付费代开发。

接入点列表:

  • 企微机器人
▼ 接口信息

接入企业微信可支持天行机器人交互功能

  • 接口地址:https://apis.tianapi.com/workweixin/index
  • 请求示例:https://apis.tianapi.com/workweixin/index?key=你的APIKEY
  • 支持协议:http/https
  • 请求方式:get/post
  • 返回格式:utf-8 json
▼ 请求参数

post方式请求时,enctype应为application/x-www-form-urlencoded

上传文件二进制数据流方式,enctype必须为multipart/form-data

参数url、base64中有特殊字符时,建议对值urlencode编码后传递

名称类型必须示例值/默认值说明
keystring您自己的APIKEY(注册账号后获得)API密钥
modeint0工作模式,宽松模式0(回答率高)、精确模式1(相关性高)、私有模式2(只从私有词库中回答)
privint0私有词库匹配模式,完整匹配0[默认]、智能匹配1,模糊匹配2,结尾匹配3,开头匹配4
▼ 返回示例

接口数据样例仅作为预览参考,请以实际测试结果为准

旧域名返回的json结构和现在略有不同,请点击此处查看说明

	
	

成功调用,code=>200并产生计费:

错误调用,查看接口错误码释义:

▼ 返回参数

公共参数指所有接口都会返回的参数,应用参数每个接口都不同

名称类型示例值说明
公共参数
codeint200状态码
msgstringsuccess错误信息
resultobject{}返回结果集
应用参数
xmlstring该接口返回xml数据请参考微信调试工具里的结构请参考上面的说明
▼ 接口价格
用户等级免费接口数每日可用次数会员价格说明
普通会员10个100次免费每个免费接口每天100次
高级会员不限1万次20元/月、120元/年(限时)每个免费接口每天1W次
黄金会员不限50万次65元/月、390元/年(限时)每个免费接口每天50W次
本接口为会员免费类接口,如业务有更高需求可点此升级会员获得更高可用次数(年付优惠)
▼ 返回状态码

错误信息可能会有所调整,请根据错误状态码(code)进行流程判断

错误状态码错误信息解释帮助
100内部服务器错误报此错误码请及时反馈或等待官方修复
110当前API已下线接口已下线无法使用,可关注相关通知
120API暂时维护中接口暂时关闭维护中,请注意相关公告
130API调用频率超限超过每秒请求数上限,可在控制台-接口管理中查询
140API没有调用权限请检查是否自行在接口管理中停用或被禁用了该接口
150API可用次数不足免费类接口套餐超限或计次类接口余额不足,点此查看说明
160账号未申请该API请先在接口文档页面申请该接口,点此查看说明
170Referer请求来源受限设置了Referer白名单,但来源Referer不在白名单内
180IP请求来源受限设置了IP白名单,但来源IP不在白名单内
190当前key不可用通常为账号无效,此状态无法恢复
230key错误或为空请检查apikey是否填写错误,点此查看帮助
240缺少key参数请检查是否传递了key参数或者编码格式是否符合要求
250数据返回为空数据查询或转换失败,请检查输入值或注意中文编码问题
260参数值不得为空请检查关键参数是否传递了空值
270参数值不符合要求参数值不符合基本格式要求,点此查看说明
280缺少必要的参数缺少必填的参数,请根据接口文档检查
290超过最大输入限制参数值超过输入范围,请查看接口文档的说明
错误码1开头的是系统级错误,2开头的是用户级错误,其中200表示请求成功处理并计费。
▼ 参考代码

此处代码仅演示关键请求片段,实际使用请根据具体环境修改

如需深入学习参考,可点击此处查看部分第三方完整开源项目

活动推荐EXERCISE 更多>

开通会员专享福利
工单 客服