开发须知

  1. 调用优音云客服服务端接口时,需使用HTTPS协议、JSON数据格式、UTF-8编码。POST请求请在HTTP Header中设置 Content-Type:application/json。

  2. 所有的请求必须携带参数tenant_id(鉴权企业的租户ID),access_token(身份凭证, 获取access_token无需封装该参数 ),否则请求不通过。
    示例:https://ykf.uincall.com/openapi/workorder/upload?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx
    注:云客服系统查看tenant_id的方式:

  3. 所有的请求必须经过IP鉴权。IP白名单信息设置请参考第二章节(secret获取及IP白名单信息设置)。
    需要客户在云客服后台增加访问的公网ip地址

  4. 每个IP调用API开放平台所有接口总量,不能超过20秒6000次。如触发限流,会禁止该IP调用开放平台所有接口5分钟。该限流不会返回对应的错误码,返回的是一个html页面,需要开发者自行处理。你可以通过增加IP的数量,来控制调用量。

  5. 每个接口每秒能被调用的次数都有一个上限(40次/秒),如触发限流,会返回错误码,且禁止该IP调用该接口5分钟。

  6. 接口调用流程
    avatar

文档更新时间: 2024-04-26 10:27   作者:admin