API接口文档
  1. 渠道合作接口
API接口文档
  • 接入说明
  • 快速入门
    • 如何发送一条消息
    • 通过接口实现群发
    • 加密externalUserId打通方案
    • unionId打通方案
    • 企业级API消息回调签名说明
  • 接口文档
    • 企业级接口
      • 企业级接口说明
      • 成员接口
        • 成员信息
          • 获取企业成员列表
          • 通过邮箱或uid获取成员详情
          • 激活成员
        • 部门信息
          • 获取部门列表
          • 获取部门成员
        • 企业内小组管理
          • 创建小组
          • 查询小组
          • 删除小组
        • 获取企业信息
          • 获取企业基础信息
        • 通过成员userid获取账号botId
          • 通过成员userid获取账号botId
        • 通过账号botId获取成员userid
          • 通过账号botId获取成员userid
        • 获取小组API信息
          • 获取企业内各小组API配置信息
          • 修改API配置信息
      • 客户接口
        • 客户信息管理
          • 获取客户列表
          • 查询客户详情
          • 企业微信外部联系人externalUserId转系统wxid
          • 系统wxid转换企业微信外部联系人externalUserId
          • 删除客户接口
          • 添加客户接口
          • 服务商id打通接口
          • 新增客户回调—RPA
          • 客户信息变更回调
          • 删除客户或者被客户删除回调
          • 修改备注手机号
          • 修改描述
          • 修改称呼
          • 修改备注
          • 客户id置换接口
          • 客户同步接口
          • 通过好友申请
          • 好友申请回调
          • 添加跟进记录v2
        • 标签管理
          • 获取自定义标签列表
          • 添加自定义标签
          • 更新自定义标签
          • 删除自定义标签
          • 增/删自定义标签
          • 添加自定义标签组
          • 删除自定义标签组
          • 修改自定义标签组名
          • 获取标签列表
          • 获取底层标签列表
          • 获取标签详情
          • 创建标签
          • 修改标签组
          • 修改标签
          • 删除标签组
          • 删除标签
          • 通过底层编辑客户企业标签
      • 托管账号接口
        • 账号操作管理
          • 获取企业内各小组托管账号信息
          • 账号托管事件回调
          • 新建托管账号
          • 删除托管账号
          • 重启托管账号
          • 查询托管账号状态
          • 输入托管账号验证码
          • 账号限制事件回调
          • 托管账号昵称变更回调
        • 托管账号标签
          • 创建托管账号标签
          • 删除托管账号标签
          • 更新托管账号标签
          • 获取托管账号标签列表
          • 给托管账号打/删标签
      • 群聊接口
        • 群聊欢迎语管理
          • 新建入群欢迎语
          • 查询入群欢迎语
          • 更新入群欢迎语
        • 群聊操作管理
          • 创建群聊
          • 将客户移出群聊
          • 将客户拉入群聊
          • 群聊改名
          • 群聊禁止改名
          • 群聊转移群主
          • 设置群管理员
          • 解散群聊
          • 修改托管账号在群聊中的昵称
          • 群活码
          • 禁止互相添加为联系人
          • 退出群聊接口
        • 群聊黑名单管理
          • 拉入群聊黑名单
          • 移出群聊黑名单
          • 获取群聊黑名单列表
        • 群聊防骚扰管理
          • 获取群聊防骚扰策略列表
          • 获取防骚扰策略生效的群聊列表
          • 应用防骚扰策略
        • 获取群聊信息
          • 获取群列表
          • 获取群二维码
          • 企业微信群chatid转系统群roomwxid
          • 系统群roomwxid转企业微信群chatid
          • 查询群详情
          • 群聊同步接口
      • 营销功能接口
        • 极速群发
          • 创建极速群发任务
          • 删除定时极速群发
          • 极速群发回调
          • 获取极速群发失败详情
        • 朋友圈
          • 查询朋友圈详情
          • 删除朋友圈
          • 朋友圈点赞回调
          • 朋友圈评论回调
          • 创建朋友圈
          • 创建朋友圈回调
          • 获取朋友圈列表
          • 朋友圈评论接口
          • 朋友圈点赞接口
        • 素材
          • 动态素材管理
            • 创建动态素材
            • 获取动态素材
          • 素材组管理
            • 获取素材组列表
            • 创建素材组
            • 更新素材组
          • 素材管理
            • 获取素材列表
            • 创建素材
            • 修改素材
            • 获取表单素材详情
        • 无限版群发
          • 无限版群发回调
          • 获取无限制群发失败详情
          • 获取群发详情
          • 创建无限版群发
          • 取消无限版群发任务
          • 查询无限版群发任务
      • 会话消息接口
        • 会话接口
          • 加入会话规则
          • 移除会话规则
          • 会话规则列表
          • 标为已读接口
          • 查询过滤规则中回话列表接口
          • 获取会话小结信息接口
          • 会话超时跟进回调
          • 设置免打扰接口
          • 设置成员上班时间
          • 自动结束会话
        • 消息接口
          • 发送消息
          • API发送消息结果回调
          • 接收消息回调 POST
          • 获取指定托管账号的聊天历史
          • 撤回消息
          • 发送消息(企微id)
        • 队列发送消息
          • 获取配置
          • 更新配置
          • 队列发送消息接口
          • 队列发送消息接口(企微id)
          • 队列发消息接口回调
      • 渠道合作接口
        • 侧边栏SDK
        • SSO概述
        • 聊天工作台 iframe 接入
        • 小组控制台 iframe 接入
      • 操作日志接口
        • 获取聚合聊天操作日志
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管企业微信列表
        • 获取个人微信授权到期及首次扫码登录的时间
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 获取指定会话
        • 获取会话列表
        • 会话事件回调
        • 分配会话
      • 加好友接口
        • 通过手机号加好友接口
        • 添加好友回调
        • 好友通过后回调
        • 群聊加好友接口
        • 通过企微id群聊加好友
      • 消息接口
        • 企微id发消息
        • 聊天历史
        • 小组级接收消息回调
        • 发送消息
      • 群发接口
        • 创建群发
        • 创建群发 Copy
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 渠道级接口
      • 渠道级接口文档说明
      • 获取代理商token
      • 获取企业基础信息
      • 代理商下企业注册回调
    • 自建应用依赖接口
      • 自建应用依赖接口说明
      • 客户信息接口
        • 新增客户回调
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 获取chatId
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 秒回数据同步
      • 获取客户列表(2023/12/05 废弃)
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定企业微信官方ID
      • 通过externalUserId获取chatId
      • 获取群列表(2023/2/05 废弃)
      • 获取成员详情
      • 编辑客户企业标签
      • 加入群聊
  • 更新日志
    • 更新日志
  • 最佳实践
    • 联系人群聊相关最佳实践
    • 消息相关最佳实践
    • AI 课程助手
  1. 渠道合作接口

SSO概述

本系统支持OAuth2.0的单点登录(sso), 以企业自有身份为身份提供商(IDP), 系统服务提供商(service provider) 简称SP, 帮您实现企业或组织自有身份与本系统之间的SSO, 即用户在IDP系统登录后即可通过跳转链接访问已配置互信关系的SP系统。

SSO 登录方式#

系统支持两种SSO登录方式
企业IDP企业idP直接SSO登录到控制台的模式
vQ87hWoMwb.jpg
系统跳回到企业IDP登录后再SSO到SP的模式
PF2hQPldDR.jpg

配置流程#

基础配置#

6wgFfdpVEc.jpg
参数介绍
参数是否必须备注
client_id是sso 应用id, 可以跟据client_id区分哪一个sso配置 。
client_secret是sso应用secret, 可用于后面获取access_token和用户信息的接口校验。

IDP 配置#

配置功能描述
用于系统跳回到企业IDP登录后再SSO到SP的模式。我们会判断系统中用户的登录状态,当登录态过期时, 会重定向到企业的IDP页面。
HNBHnc7iyk.jpg
参数介绍
参数是否必须备注
接口地址是发起登录的地址,只需要填写域名即可,我们将client_id 和client_secret 和redirect_uri拼接到url上, 如:接口地址填写:【https://open.ceshisso.com/connect/oauth2/authorize】 , 那请求的url是:【https://open.ceshisso.com/connect/oauth2/authorize?client_id=**&redirect_url=**&&response_type=code】 。
参数设置是我们将这里的参数拼接到接口的url上。
第三方登录后跳转本系统平台地址否跳转本系统地址,会拼接在redirect_url后面。

获取AccessToken#

配置功能描述
通过上面IDP配置,当通过企业idp登录之后,会通过redirect_url重定向我们系统,此时需要携带授权码code过来,比如:https://agency-test.ceshibot.com/sso/oidc?code=****, 我们会利用下面的请求配置获取token。
P7XJrXFxS4.jpg
参数介绍
参数是否必须备注
请求地址是获取access_token地址
请求类型是接口调用方式: GET或POST
参数内容解析否当选择post的时候, 参数编码可以选择application/json 或者 x-www-from-urlencoded。
body 设置否根据选择的请求类型,我们将body里面的参数拼接到url上或者body上,可用于接口校验。
返回参数
参数是否必须备注
access_token是用于配置access_token的解析格式, access_token可用于获取后面用户信息。
tokenExtraField否用于其他的参数的解析, 通过tokenExtraField解析出来的参数会在调用用户信息的时候原封不动的返回。
返回参数解析规则
如: 在返回的参数中解析出acccess_token, 例如返回参数:
{
  access_token: "token_data",
}
那么access_token的配置就需要填写: $.access_token, 如果返回参数为:
{
    data: {
      access_token: "token_data"
    }
}
那么access_token的配置就需要填写 $.data.access_token, tokenExtraField也是同样的规则。

获取用户信息#

通过上面获取access_token 获取用户信息, 该请求为Get请求。
szLQLLbhc4.jpg
参数介绍
参数是否必须备注
接口地址是通过上面拿到的access_token获取用户信息, 例如填写: https:///open.ceshisso.com/getUserInfo,我们将access_token拼接到url上,发出GET请求,实际的请求就是https:///open.ceshisso.com/getUserInfo?access_token=*** 。
返回参数
解析规则同access_token 一致
参数是否必须备注
email是企业IDP 和服务提供商 用户匹配字段。
orgId是企业IDP返回的企业id, 用于匹配系统的企业。
userName否可选字段, 当返回这个字段后,会自动创建系统的企业员工,加入到默认小组, 赋予普通成员的权限。
corpName否可选字段, 当放回这个字段后, 会自动创建系统企业, 并将传输的用户信息作为创建者。
上一页
侧边栏SDK
下一页
聊天工作台 iframe 接入
Built with