云真机

API接口文档


常见问题

<p>此处列举了对接过程中的一些常见问题,后面会不断完善,供对接时参考。</p> <h4>1、参数错误怎么处理?</h4> <p>报参数错误,如:app_id错误、app_id过期、grant_type错误,要先排查:请求方式(get/post)、请求参数(headers和其他参数)、传参方式(本平台post请求一般使用的是json格式传参);常见的原因除了上面几种,还可能是API套餐过期需要联系销售或客服、传的json参数中包含了从文档里拷贝出来的注释部分(&quot;//...&quot;)。</p> <h4>2、添加联系人(contactAdd),返回:不符合添加条件指的是什么</h4> <p>添加联系人(contactAdd),参数flag 默认是1,也就是仅加对方个微号,如果搜索到的只有企微,就会报:不符合添加条件,忽略! ,所以要注意参数;</p> <h4>3、回调数据加解密不对怎么排查</h4> <p>在参照示例已完成对接的情况下,出现有些内容解密成功,有些内容失败的情况,可以排查:(1)、开通了多个APPID,都用同一套写死的参数去解密,导致解密失败;(2)、有遇到post到回调地址的body内容过长,超过了被回调方配置或代码里的长度限制,导致密文被截断解密失败;</p> <h4>4、接收回调数据报数据内容不是json的错误</h4> <p>由于历史原因,回调请求时使用的Content-Type延续了:application/json, 但实际加密后的内容是纯文本(理应使用text/plain),此处需要被回调方做兼容处理,整个body部分是一段纯文本,解密后是一段json数据。</p> <h4>5、收不到消息和事件回调</h4> <p>要能正常使用本系统平台,需要先保证在本系统里登录上线企微号,不要离线。只有这样才能及时、正常从企微客户端同步到数据,并在接收到上报数据后,回调到被回调方的回调地址上。另外,排查原因时,可以打开网络服务器的日志配置(如Nginx的access日志),尽量直接查看网络请求日志,而不是查看代码里打印的日志,避免是代码处理导致的数据丢失。</p> <h4>6、接口有没有限制</h4> <p>为了保证系统的稳定可用,我们对接口做了一定的频次限制,详见:&lt;a href=&quot;<a href="https://www.showdoc.com.cn/qybopen/9100823788620494&quot;&gt;接口调用频次限制说明&lt;/a&gt;,除了我们平台设置的接口限制外(一般不会触发),常见如遇到:发送频率太快、发送过于频繁、发消息或添加好友或建群或邀请进群无效等问题,一般都是企微官方的限制,这种情况跟账号的权重有关,需要慢慢提升权重(可联系客服咨询">https://www.showdoc.com.cn/qybopen/9100823788620494&quot;&gt;接口调用频次限制说明&lt;/a&gt;,除了我们平台设置的接口限制外(一般不会触发),常见如遇到:发送频率太快、发送过于频繁、发消息或添加好友或建群或邀请进群无效等问题,一般都是企微官方的限制,这种情况跟账号的权重有关,需要慢慢提升权重(可联系客服咨询</a>)。</p> <h4>7、发了消息、发了指令,返回成功了,但是实际没成功</h4> <p>执行发送消息或其他指令都是异步交给企微客户端去执行的,请求的接口响应了:errcode=0,仅仅表示此次请求已经过了我们平台的初步校验,消息或指令已经成功交给了企微客户端等待企微客户端异步执行,不代表已经成功或者一定成功;执行结果会以不同的形式,异步通知给被回调方,具体情况参考具体文档。</p> <p>&lt;font color=&quot;red&quot;&gt;消息发出去,但没收到,可按如下步骤排查问题: 1、先对照接口文档检查请求方式、参数是否都正确; 2、登录本系统,找到对应的聊天会话,看看API发的消息有没有出现在会话里,有的话,可以直接看到消息状态或账号是否异常的状态的;&lt;/font&gt;</p> <h4>8、建群指令,可以添加企业微信通讯录里面的同事到群里吗?怎么操作?</h4> <p>可以添加。但是要先拿到通讯录里面同事在企微宝系统的wxid,才能使用企微宝下发指令。操作方法:需要建个外部群,把同事手动拉到群里。然后就可以通过企微宝的群成员列表接口去获取到所有同事在企微宝系统里的wxid了。</p> <h3>9、聊天消息怎么区分是内部员工的聊天还是和外部客户的聊天?</h3> <p>wxid,16开头都是企业微信号,7开头都是个微微信号。判断是否是内部员工聊天,有两个方式:1、维护一份内部员工数据(手动拉到一个群里);2、可以根据消息的from_wxid、to_wxid 查客户表,查不到的话可以认为是内部员工。</p> <h3>10、关于建群、群信息和群成员头像、昵称的问题?</h3> <p>1、托管企微号创建的群,群信息会报上来;托管企微号被拉到其他人建的群,群信息默认不会上报,需要其他人在群里发条消息才会触发被托管企微号上报上来。 这两种情况,群成员头像昵称默认都没有,都需要请求&lt;a href=&quot;<a href="https://www.showdoc.com.cn/qybopen/7988098275293212#refresh&quot;&gt;【刷新群信息接口】&lt;/a&gt;去触发获取并上报,后续新加入的群成员,头像昵称是会有的">https://www.showdoc.com.cn/qybopen/7988098275293212#refresh&quot;&gt;【刷新群信息接口】&lt;/a&gt;去触发获取并上报,后续新加入的群成员,头像昵称是会有的</a>。</p> <p>2、历史群,在企微登录在企微宝上时会全量同步一次。但是有些群在企微宝上没显示的话,是因为软件同步企微电脑端的对话列表和通讯录里的群,电脑端就没有这个些群,这种情况只能往群内发下消息,或者将群添加到通讯录再看下。</p>

页面列表

ITEM_HTML