1 口令登录及扫描二维码登录

1. 使用大页面:
http://(domain)/lop/oauth2/show?appid=APPID&redirect_uri=REDIRECT_URL&response_type=code&scope=snsapi_userinfo&state=STATE
2. 通过iframe嵌入登录页面:
a)二维码页面
http://(domain)/lop/oauth2/show?appid=APPID&redirect_uri=REDIRECT_URL&response_type=code&scope=snsapi_userinfo&state=STATE&display=small
b) 口令登陆页面
http://(domain)/lop/oauth2/show?appid=APPID&redirect_uri=REDIRECT_URL&response_type=code&scope=snsapi_userinfo&state=STATE&display=smallLogin
接口名:
http://domain/connect/oauth2/authorize?appid=lopsdktest&redirect_uri=REDIRECT_URL&response_type=code&scope=snsapi_userinfo&state=1
接口描述:
获取authorization Code,用来获取accessToken
http请求方式:POST/GET
request参数对象:
参数 是否必须 含义
response_type 授权类型,此值固定为“code”
appid 申请蓝信登录成功后,分配给应用的appid
redirect_uri 成功授权后的回调地址,必须是注册appid时填写的主域名下的地址,建议设置为网站首页或网站的用户中心。注意需要将url进行URLEncode
state client端的状态值。用于第三方应用防止CSRF攻击,成功授权后回调时会原样带回。请务必严格按照流程检查用户与state参数状态的绑定
scope 请求用户授权时向用户显示的可进行授权的列表. 可填写的值参考附录1. 如果要填写多个接口名称,请用逗号隔开。不传则默认仅针对登陆进行授权(即没有任何信息)。
response参数对象:

1.如果用户成功登录并授权,则会跳转到指定的回调地址,并在redirect_uri地址后带上Authorization Code和原始的appid 和state值。如:

http://open.lanxin.cn/demo/index.jsp?code=DEFA*********************E6AF&appid=XXXstate=009988uuiadelw
注意:此code会在5分钟内过期。

2.如果用户在登录授权过程中取消登录流程,登录页面直接关闭;

接口调用有错误时,会返回errcode和errmsg字段,以url参数对的形式返回,value部分会进行url编码(UTF-8)。

3.该认证地址一般会配置在公号的view类型的菜单中,此时要求回调地址为固定地址,不可更改。

4.如果回调地址不固定,需根据业务任意指定,此时oauth认证接口需要开发者自己去构造。(目前蓝信只支持菜单中配置固定回调地址的oauth,开发者自己构造的oauth接口目前还不支持,在后续版本中放开)

接口名:
http://ip:端口/sns/oauth2/access_token? code =CODE&appid=APPID&grant_type=authorization_code
接口描述:
获取access_token,注意此处access_token和开发者文档中的access_token不一样。
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
appid 公众号的唯一标识
code 填写第一步获取的code参数
grant_type 填写为authorization_code
response参数对象:
参数 描述
access_token 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同
expires_in access_token接口调用凭证超时时间,单位(秒)
refresh_token 用户刷新access_token
openid 用户唯一标识(手机号 或userUniId)
scope 用户授权的作用域
返回数据示例:
{
   "errcode": 0,
   "errmsg": "请求成功",
   "access_token":"ACCESS_TOKEN",
   "expires_in":7200,
   "refresh_token":"REFRESH_TOKEN",
   "openid":"OPENID",
   "scope":"SCOPE"
}
接口名:
http://ip:端口/sns/oauth2/refresh_token? refresh_token=REFRESH_TOKEN
&appid=APPID&grant_type=refresh_token
接口描述:
由于access_token拥有较短的有效期,当access_token超时后,可以使用refresh_token进行刷新,refresh_token拥有较长的有效期(30天),当refresh_token失效的后,需要用户重新授权。
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
appid 公众号的唯一标识
grant_type 填写为refresh_token
refresh_token 填写通过access_token获取到的refresh_token参数
response参数对象:
参数 描述
access_token 网页授权接口调用凭证,注意:此access_token与开发者文档中的access_token不同
expires_in access_token接口调用凭证超时时间,单位(秒)
refresh_token 用户刷新access_token
openid 用户唯一标识(手机号 或 userUniId)
返回数据示例:
{
   "errcode": 0,
   "errmsg": "请求成功",
   "access_token":"ACCESS_TOKEN",
   "expires_in":7200,
   "refresh_token":"REFRESH_TOKEN",
   "openid":"OPENID",
   "scope":"SCOPE"
}
接口名:
http://ip:端口/sns/userinfo? access_token=ACCESS_TOKEN
&mobile=MOBILE(或USERUUNIID)
接口描述:
由于access_token拥有较短的有效期,当access_token超时后,可以使用refresh_token进行刷新,refresh_token拥有较长的有效期(30天),当refresh_token失效的后,需要用户重新授权。
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同
mobile 用户的唯一标识(openid )
response参数对象(当返回的数据中某个字段的值为null时,该key-value在报文中不显示)
参数 描述
errcode 状态码
errmsg 返回状态描述
id 成员id
name 成员名称
email Email
mobile 手机号或USERUUNIID
path 成员在组织中的位置
parentId 成员所在部门ID
orgName 成员所在组织名称,一般和company一样。如果是集团公司,orgName为集团名称
company 成员所在公司名称,对应蓝信中的“单位”,一般和orgName一样。如果为集团公司,company一般为集团子公司名称
返回数据示例:
{
    "errcode": 0,
    "errmsg": "请求成功",
    "openOrgMemberList": [
        {
           "name": "杨雪",
           "id": 1113,
           "path": "蓝信工场-研发部",
           "serialNumber":序号,
           "position":职位,
           "note":"",
           "mobile": "18612345678",
           "parentId": 111111,
           "companyId":594771
           "email": "yangxue@comisys.net",
           "secondPosition":"",
           "userUniId":"83191@34.uni1",
           "company": "蓝信工场"
           "busiTags":[],
           "posiTags":[],
           "contactExs":[],
           "orgName": "蓝信工场",
           "orgId": 1
        }
    ]
}
接口名:
http://domain/connect/oauth2/getcode?appid=lopsdktest &response_type=code&scope=snsapi_userinfo&state=1
接口描述:
获取authorization Code,用来获取accessToken
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
response_type 授权类型,此值固定为“code”
appid 申请蓝信登录成功后,分配给应用的appid
state client端的状态值。用于第三方应用防止CSRF攻击,成功授权后回调时会原样带回。请务必严格按照流程检查用户与state参数状态的绑定
scope 请求用户授权时向用户显示的可进行授权的列表. 可填写的值参考附录1. 如果要填写多个接口名称,请用逗号隔开。不传则默认仅针对登陆进行授权(即没有任何信息)。
response参数对象:

如果用户成功登录并授权,则会跳转到公号指定的服务地址上(即,公号对应的应用的服务地址),并在在该地址后带上Authorization Code和原始的appid 和state值。如:

http://open.lanxin.cn/demo/index.jsp?code=DEFA*********************E6A&appid=XXX&state=1

注意:使用此接口的前提是公号是通过应用配置出来的,公号的回调地址和服务地址即应用的回调地址和服务地址。此code会在5分钟内过期。

接口名:
http://ip:端口/lop/photo/res/show? access_token=ACCESS_TOKEN
&resId=RESID(头像资源id)
接口描述:
获取头像
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用凭证,注意:此access_token与基础支持的access_token不同
resId 头像资源id
response参数对象:
头像二进制数据

2 组织列表

接口名:
http://ip:端口/lop/orgentity/get? access_token=ACCESS_TOKEN
接口描述:
获取组织机构列表。
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
response参数对象:
1)
参数 描述
errcode 请求状态
data 组织数据
2) 组织对象:
参数 描述
id 组织ID
name 组织名
返回数据示例:
a) 成功返回:
{
    "errcode": 0,
    "errmsg":"",
    "data": [
        {
            "id": 803,
            "name": "测试组织"
        },
        {
            "id": 1112,
            "name": "办公OA联调测试"
        }
    ]
}

3 通讯录成员列表

接口名:
http://ip:端口/lop/members/get? access_token=ACCESS_TOKEN
接口描述:
获取通讯录成员列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
structId 分支ID
currentPage 当前页
response参数对象(当返回的数据中某个字段的值为null时,该key-value在报文中不显示)
参数 描述
errcode 请求状态
errmsg 错误信息
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 成员ID
mobile 手机号
company 公司
email 邮箱
fax 传真
orgId 组织ID
photoUrl 头像Url
position 职务
registered 是否注册:1表示已注册;
roleCode 角色
seq 排序
telephone 电话
parentId 父ID,所属部门
busiTags 业务属性列表
serialNumber 序列号,如警号
posiTags 职务属性列表
note 备注,说明
secondPosition 岗位类别
contactExs 联系方式扩展
返回数据示例:
b) 成功返回:
{
    "errcode": 0,
    "totalCount": 96,
    "pageSize":20,
    " currentPage":1,
    "data": [
        {
            "id": 154284,
            "name": "张三",
            "mobile": "18000000000",
            "company": "九州智通科技有限公司",
            "email": "zhangsan@comisys.net",
            "fax": "",
            "orgId": 804,
            " photoUrl ": "",
            "position": "总经理",
            "registered": 1,
            "roleCode": "ORG-VIP",
            "seq": 1,
            "telephone": "1062561313",
            "parentId": 154275,
            "busiTags": [],
            "serialNumber": "",
            "posiTags": [],
            "note": "",
            "secondPosition": "",
            "contactExs": []
        },
        {
            "id": 154284,
            "name": "李四",
            "mobile": "18000000001",
            "company": "九州智通科技有限公司",
            "email": "lisi@comisys.net",
            "fax": "",
            "orgId": 804,
            " photoUrl ": "",
            "position": "副总经理",
            "registered": 1,
            "roleCode": "ORG-VIP",
            "seq": 1,
            "telephone": "1062561313",
            "parentId": 154275,
            "busiTags": [],
            "serialNumber": "",
            "posiTags": [],
            "note": "",
            "secondPosition": "",
            "contactExs": []
        }
    ]
}

4 分支

接口名:
http://ip:端口/lop/structs/get? access_token=ACCESS_TOKEN
接口描述:
获取通讯录列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
orgId 组织ID
structId 分支ID
type 0:分支节点;1:成员节点;-1:全部节点
response参数对象(当返回的数据中某个字段的值为null时,该key-value在报文中不显示)
参数 描述
errcode 请求状态
id id
code 代码
name 分支名
category 分支所属类别(0,部门;1,单位)
hasChildNode 是否有子节点
orgId 组织ID
orgMemberId 排序
parentId 电话
path 父ID,所属部门
seq 排序
type 节点类型,0表示部门节点;1表示成员节点
level 层级
companyId Id
companyLevel 层级
返回数据示例:
c) 成功返回:
{
    "errcode": 0,
    "data": [
        {
            "id": 145946,
            "code":"34-594771",
            "name": "九州智通科技有限公司",
            "category": 0,
            "hasChildNode": 0,
            "orgId": 804,
            "orgMemberId": 0,
            "parentId": 0,
            "path": "九州智通科技有限公司",
            "seq": 0,
            "type": 0,
            "level": 2,
            "companyId":595533,
            "companyLevel":2
        },
        ......
    ]
}

5 私信会话列表

接口名:
http://ip:端口/lop/private/message/dialog/get? access_token=ACCESS_TOKEN
接口描述:
获取私信会话列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 会话记录ID
dialogId 会话ID
name 发送人名称
photoUrl 发送人头像,没有时为空
userMessage 会话中显示的最后一条消息
beenRead 是否已阅读
dialogId 消息发送方向:1表示发送消息,2表示接收消息
contactInfo 他人信息,direction为1时,表示消息接收人手机号;direction为2时,表示发送人手机号
contactName 他人信息,direction为1时,表示消息接收人名称;direction为2时,表示消息发送人名称
contentType 2.富媒体消息
3.html链接消息
4.SIP消息
5.邮件消息
6.多图消息
7.群名片消息
message 消息内容,base64加密的结果
messageType 1. 私信
2. 群聊消息
refId 类别为活动消息或投票消息时有值,用于关联活动等信息
selfInfo 自己的手机号
sendTime 发送时间
sendingState 0: 发送完成;1:发送中,-1: 草稿;2: 待接收(离线消息)
接收的消息中填 0 即可
attachmentName 附件文件名
attachmentResId 附件资源ID
attachmentSize 附件大小
返回数据示例:
d) 成功返回:
{
    "errcode": 0,
    "totalCount": 2,
    "pageSize":20,
    " currentPage":1,
    "data": [
        {
            "id": 4907551,
            "name": "开放平台",
            "photoUrl": "http://login.lanxin.cn/temData/c/mmsUpload/114c809a-eefe-4694-bb83-2f60e5261658_36",
            "dialogId": "103049",
            "userMessage": {
                "beenRead": 0,
                "category": 0,
                "contactInfo": "18600000000",
                "contactName": "张三",
                "contentType": 2,
                "dialogId": "103049",
                "direction": 1,
                "id": 4907551,
                "message": "5Lit5Zu96ZOB5bu66IKh5Lu95pyJ6ZmQ5YWs5Y+4IGh0dHA6Ly9hcGkubGFueGluLmNuL2Rpc3BsYXkvbmV3cy8yNDg/Y291bnQ9NCZ0aW1lc3RhbXA9MTQwOTIxNzA5Nzg5MA==",
                "messageType": 1,
                "refId": 0,
                "selfInfo": "18600598413",
                "sendResult": 0,
                "sendTime": 1409217097893,
                "sendingState": 0,
                "attachmentName": "copypaste.png",
                "attachmentSize": "18.88KB",
                "attachmentResId": "4f7955b7-aff1-4527-bcc8-156558b2ce13",
                "userId": 127586
            }
        }
    ]
}

6 私信消息列表

接口名:
http://ip:端口/lop/private/message/get? access_token=ACCESS_TOKEN
接口描述:
获取私信消息列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
dialogId 会话ID
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
dialogId 消息发送方向:1表示发送消息,2表示接收消息
beenRead 是否已阅读
contactInfo 他人信息,direction为1时,表示消息接收人手机号;direction为2时,表示发送人手机号
contactName 他人信息,direction为1时,表示消息接收人名称;direction为2时,表示消息发送人名称
contentType 0: 短信
1: 彩信
2.富媒体消息
3.html链接消息
4.SIP消息
5.邮件消息
6.多图消息
7.群名片消息
message 消息内容,base64加密的结果
messageType 1. 私信
2. 群聊消息
refId 类别为活动消息或投票消息时有值,用于关联活动等信息
selfInfo 自己的手机号
sendTime 发送时间
sendingState 0: 发送完成;1:发送中,-1: 草稿;2: 待接收(离线消息)
接收的消息中填 0 即可
attachmentName 附件文件名
attachmentResId 附件资源ID
attachmentSize 附件大小
返回数据示例:
e) 成功返回:
{
    "errcode": 0,
    "totalCount": 1,
    "pageSize":20,
    " currentPage":1,
    "data": [
        {
        "id": 4907551,
        "beenRead": 0,
        "category": 0,
        "contactInfo": "1862222222",
        "contactName": "张三",
            "contentType": 2,
            "dialogId": "103049",
            "direction": 2,
            "message": "5Lit5Zu96ZOB5bu66IKh5Lu95pyJ6ZmQ5YWs5Y+4IGh0dHA6Ly9hcGkubGFueGluLmNuL2Rpc3BsYXkvbmV3cy8yNDg/Y291bnQ9NCZ0aW1lc3RhbXA9MTQwOTIxNzA5Nzg5MA==",
            "messageType": 1,
            "refId": 0,
            "selfInfo": "18600598413",
            "sendResult": 0,
            "sendTime": 1409217097893,
            "sendingState": 0,
        "mimeType": "image/png",
        "attachmentName": "copypaste.png",
        "attachmentSize": "18.88KB",
            "attachmentResId": "4f7955b7-aff1-4527-bcc8-156558b2ce13",
            "userId": 127586
        }
    ]
}

7 发送私信

接口名:
http://ip:端口/lop/private/message/send? access_token=ACCESS_TOKEN
接口描述:
发送私信
http请求方式:POST,POST一个JSON数据包来发送消息
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
response参数对象:
参数 描述
errcode 请求状态
errmsg 请求信息
返回数据示例:
f) 成功返回:
{
    "errcode": 0,
    "errmsg": "请求成功",
}
消息体对象
参数 描述
touser 接收方帐号
msgtype 消息类型:text
content 文本消息内容
示例数据
{
    "touser": "USERUNIID",
    "msgtype": "text",
    "text": {
        "content": "Hello World"
    }
}

支持图片、音频、视频、office文件等附件消息。

消息体对象
参数 描述
touser 接收方帐号
msgtype 消息类型:attachment
media_id 附件资源文件ID
示例数据
{
    "touser": "USERUNIID",
    "msgtype": "attachment",
    "attachment": {
        "media_id": "MEDIA_ID"
    }
}
消息体对象
参数 描述
touser 接收方帐号
msgtype 消息类型:link
url 链接地址
示例数据
{
    "touser": "USERUNIID",
    "msgtype": "link",
    "link": {
        "url": "http://www.lanxin.cn"
    }
}

图文消息条数限制在10条以内,注意,如果图文数超过10,则将会无响应。

消息体对象
参数 是否必须 描述
touser 接收方帐号
msgtype 消息类型:news
title 图文标题
description 描述
url 点击后跳转的链接
picurl 图文消息的图片链接
type 图文消息链接类型,默认值为0:0 URL;1 语音; 2 视频; 3 文档 ; 4 未知
flag int类型:0 默认值,可以不传;

1. 访问link的时候增加name和telephone要求以_ckey为可以传递。例如:http://host/path/uri?_ckey=base64(name=name&telephone=telephon)
示例数据
{
    "touser": "USERUNIID",
    "msgtype": "news",
    "news": {
        "articles": [
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            },
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            }
        ]
    }
}

8 群会话列表

接口名:
http://ip:端口/lop/qun/message/dialog/get? access_token=ACCESS_TOKEN
接口描述:
获取群会话列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 群会话记录ID
dialogId 群会话ID
name 群名称
photoUrl 群头像,没有时为空
userMessage 会话中显示的最后一条消息
beenRead 是否已阅读
category 消息发送方向:1表示发送消息,2表示接收消息
contactInfo 他人信息,direction为1时,表示消息接收人手机号;direction为2时,表示发送人手机号
contactName 他人信息,direction为1时,表示消息接收人名称;direction为2时,表示消息发送人名称
contentType 2.富媒体消息
3.html链接消息
4.SIP消息
5.邮件消息
6.多图消息
7.群名片消息
message 消息内容,base64加密的结果
messageType 1. 私信
2. 群聊消息
refId 类别为活动消息或投票消息时有值,用于关联活动等信息
selfInfo 自己的手机号
sendTime 发送时间
sendingState 0: 发送完成;1:发送中,-1: 草稿;2: 待接收(离线消息)
接收的消息中填 0 即可
attachmentName 附件文件名
attachmentResId 附件资源ID
attachmentSize 附件大小
返回数据示例:
g) 成功返回:
{
    "errcode": 0,
    "totalCount": 2,
    "pageSize":20,
    " currentPage":1,
    "data": [
        {
            "id": 4907551,
            "name": "开放平台",
            "photoUrl": "http://login.lanxin.cn/temData/c/mmsUpload/114c809a-eefe-4694-bb83-2f60e5261658_36",
            "dialogId": "103049",
            "userMessage": {
                "beenRead": 0,
                "category": 0,
                "contactInfo": "18600000000",
                "contactName": "张三",
                "contentType": 2,
                "dialogId": "103049",
                "direction": 1,
                "id": 4907551,
                "message": "5Lit5Zu96ZOB5bu66IKh5Lu95pyJ6ZmQ5YWs5Y+4IGh0dHA6Ly9hcGkubGFueGluLmNuL2Rpc3BsYXkvbmV3cy8yNDg/Y291bnQ9NCZ0aW1lc3RhbXA9MTQwOTIxNzA5Nzg5MA==",
                "messageType": 1,
                "refId": 0,
                "selfInfo": "18600598413",
                "sendResult": 0,
                "sendTime": 1409217097893,
                "sendingState": 0,
                "attachmentName": "copypaste.png",
                "attachmentSize": "18.88KB",
                "attachmentResId": "4f7955b7-aff1-4527-bcc8-156558b2ce13",
                "userId": 127586
            }
        }
    ]
}

9 群消息列表

接口名:
http://ip:端口/lop/qun/message/get? access_token=ACCESS_TOKEN
接口描述:
获取群消息列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
dialogId 会话ID
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 消息记录ID
dialogId 消息所在会话ID
category 消息发送方向:1表示发送消息,2表示接收消息
direction 消息发送方向:1表示发送消息,2表示接收消息
beenRead 是否已阅读
contactInfo 他人信息,direction为1时,表示消息接收人手机号;direction为2时,表示发送人手机号
contactName 他人信息,direction为1时,表示消息接收人名称;direction为2时,表示消息发送人名称
contentType 2.富媒体消息
3.html链接消息
4.SIP消息
5.邮件消息
6.多图消息
7.群名片消息
message 消息内容,base64加密的结果
messageType 1. 私信
2. 群聊消息
refId 类别为活动消息或投票消息时有值,用于关联活动等信息
selfInfo 自己的手机号
sendTime 发送时间
sendingState 0: 发送完成;1:发送中,-1: 草稿;2: 待接收(离线消息)
接收的消息中填 0 即可
attachmentName 附件文件名
attachmentResId 附件资源ID
attachmentSize 附件大小
返回数据示例:
h) 成功返回:
{
    "errcode": 0,
    "totalCount": 1,
    "pageSize":20,
    " currentPage":1,
    "data": [
        {
        "id": 4907551,
        "beenRead": 0,
        "category": 0,
        "contactInfo": "1862222222",
        "contactName": "张三",
            "contentType": 2,
            "dialogId": "103049",
            "direction": 2,
            "message": "5Lit5Zu96ZOB5bu66IKh5Lu95pyJ6ZmQ5YWs5Y+4IGh0dHA6Ly9hcGkubGFueGluLmNuL2Rpc3BsYXkvbmV3cy8yNDg/Y291bnQ9NCZ0aW1lc3RhbXA9MTQwOTIxNzA5Nzg5MA==",
            "messageType": 1,
            "refId": 0,
            "selfInfo": "18600598413",
            "sendResult": 0,
            "sendTime": 1409217097893,
            "sendingState": 0,
        "mimeType": "image/png",
        "attachmentName": "copypaste.png",
        "attachmentSize": "18.88KB",
            "attachmentResId": "4f7955b7-aff1-4527-bcc8-156558b2ce13",
            "userId": 127586
        }
    ]
}

10 发送群消息

接口名:
http://ip:端口/lop/qun/message/send? access_token=ACCESS_TOKEN
接口描述:
发送群消息
http请求方式:POST/GET,POST一个JSON数据包发送消息,和发送私信类似。
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
response参数对象:
参数 描述
errcode 请求状态
errmsg 请求信息
返回数据示例:
i) 成功返回:
{
    "errcode": 0,
    "errmsg":"请求成功"
}
消息体对象
参数 描述
tousers 多个接收方USERUNIID,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toqun 可以在利用已有群完成群发,填写QUNDIALOGID
toall true:群发给整个组织;false:按照tousers、togroups群发
msgtype 消息类型:text
content 文本消息内容
示例数据
{
    "toall": false,
    "tousers": ["USERUNIID1","USERUNIID2"],
    "togroups": ["分支1","分支2"],
    "toqun" : "Qun-1234@34.uni1",
    "msgtype": "text",
    "text": {
        "content": "Hello World"
    }
}

支持图片、音频、视频、office文件等附件消息。

消息体对象
参数 描述
tousers 多个接收方USERUNIID,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toall true:群发给整个组织;false:按照tousers、togroups群发
toqun 可以在利用已有群完成群发,填写QUNDIALOGID
msgtype 消息类型:attachment
media_id 附件资源文件ID
示例数据
{
    "toall": false,
    "tousers": ["USERUNIID1","USERUNIID2"],
    "togroups": ["分支1","分支2"],
    "toqun" : "Qun-1234@34.uni1",
    "msgtype": "attachment",
    "attachment": {
        "media_id": "MEDIA_ID"
    }
}
消息体对象
参数 描述
tousers 多个接收方USERUNIID,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toall true:群发给整个组织;false:按照tousers、togroups群发
toqun 可以在利用已有群完成群发,填写QUNDIALOGID
msgtype 消息类型:link
url 链接地址
示例数据
{
    "toall": false,
    "tousers": ["USERUNIID1","USERUNIID2"],
    "togroups": ["分支1","分支2"],
    "toqun" : "Qun-1234@34.uni1",
    "msgtype": "link",
    "link": {
        "url": "http://www.lanxin.cn"
    }
}

图文消息条数限制在10条以内,注意,如果图文数超过10,则将会无响应。

消息体对象
参数 是否必须 描述
tousers 多个接收方USERUNIID,多个以“,”间隔,tousers和togroups二者至少有一个
togroups 多个接收方分支ID,多个以“,”间隔
toall true:群发给整个组织;false:按照tousers、togroups群发
toqun 可以在利用已有群完成群发,填写QUNDIALOGID
msgtype 消息类型:news
title 图文标题
description 描述
url 点击后跳转的链接
picurl 图文消息的图片链接
type 图文消息链接类型,默认值为0:0 URL;1 语音; 2 视频; 3 文档 ; 4 未知
flag int类型:0 默认值,可以不传;

1. 访问link的时候增加name和telephone要求以_ckey为可以传递。例如:http://host/path/uri?_ckey=base64(name=name&telephone=telephon)
示例数据
{
    "toall": false,
    "tousers": ["USERUNIID1","USERUNIID2"],
    "togroups": ["分支1","分支2"],
    "toqun" : "Qun-1234@34.uni1",
    "msgtype": "news",
    "news": {
        "articles": [
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            },
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            }
        ]
    }
}

11 工作群成员列表

接口名:
http://ip:端口/lop/qun/member/get? access_token=ACCESS_TOKEN
接口描述:
获取工作群成员列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
qunId 群ID
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 成员ID
mobile 手机号
company 公司
email 邮箱
fax 传真
orgId 组织ID
photoUrl 头像Url
position 职务
registered 是否注册:1表示已注册;
roleCode 角色
seq 排序
telephone 电话
parentId 父ID,所属部门
返回数据示例:
j) 成功返回:
{
    "errcode": 0,
    "totalCount": 96,
    "pageSize":20,
    "currentPage":1,
    "data": [
        {
            "id": 154284,
            "name": "张三",
            "mobile": "18000000000",
            "company": "九州智通科技有限公司",
            "email": "zhangsan@comisys.net",
            "fax": "",
            "orgId": 804,
            "photoUrl": "",
            "position": "总经理",
            "registered": 1,
            "roleCode": "ORG-VIP",
            "seq": 1,
            "telephone": "1062561313",
            "parentId": 154275
        },
        {
            "id": 154284,
            "name": "李四",
            "mobile": "18000000001",
            "company": "九州智通科技有限公司",
            "email": "lisi@comisys.net",
            "fax": "",
            "orgId": 804,
            "photoUrl": "",
            "position": "副总经理",
            "registered": 1,
            "roleCode": "ORG-VIP",
            "seq": 1,
            "telephone": "1062561313",
            "parentId": 154275
        }
    ]
}

12 群发群会话列表

接口名:
http://ip:端口/lop/mass/message/dialog/get? access_token=ACCESS_TOKEN
接口描述:
获取群会话列表
http请求方式:POST/GET
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
currentPage 获取第几页数据
response参数对象:
参数 描述
errcode 请求状态
totalCount 总记录数
pageSize 每页记录数
currentPage 当前页(第几页)
id 群会话记录ID
dialogId 会话ID
name 群名称
photoUrl 群头像,没有时为空
userMessage 会话中显示的最后一条消息
beenRead 是否已阅读
dialogId 消息发送方向:1表示发送消息,2表示接收消息
contactInfo 他人信息,direction为1时,表示消息接收人手机号;direction为2时,表示发送人手机号
contactName 他人信息,direction为1时,表示消息接收人名称;direction为2时,表示消息发送人名称
contentType 2.富媒体消息
3.html链接消息
4.SIP消息
5.邮件消息
6.多图消息
7.群名片消息
message 消息内容,base64加密的结果
messageType 1. 私信
2. 群聊消息
refId 类别为活动消息或投票消息时有值,用于关联活动等信息
selfInfo 自己的手机号
sendTime 发送时间
sendingState 0: 发送完成;1:发送中,-1: 草稿;2: 待接收(离线消息)
接收的消息中填 0 即可
attachmentName 附件文件名
attachmentResId 附件资源ID
attachmentSize 附件大小
返回数据示例:
k) 成功返回:
{
    "errcode": 0,
    "totalCount": 2,
    "pageSize":20,
    "currentPage":1,
    "data": [
        {
            "id": 4907551,
            "name": "开放平台",
            "photoUrl": "http://login.lanxin.cn/temData/c/mmsUpload/114c809a-eefe-4694-bb83-2f60e5261658_36",
            "dialogId": "103049",
            "userMessage": {
                "beenRead": 0,
                "category": 0,
                "contactInfo": "18600000000",
                "contactName": "张三",
                "contentType": 2,
                "dialogId": "103049",
                "direction": 1,
                "id": 4907551,
                "message": "5Lit5Zu96ZOB5bu66IKh5Lu95pyJ6ZmQ5YWs5Y+4IGh0dHA6Ly9hcGkubGFueGluLmNuL2Rpc3BsYXkvbmV3cy8yNDg/Y291bnQ9NCZ0aW1lc3RhbXA9MTQwOTIxNzA5Nzg5MA==",
                "messageType": 1,
                "refId": 0,
                "selfInfo": "18600598413",
                "sendResult": 0,
                "sendTime": 1409217097893,
                "sendingState": 0,
                "attachmentName": "copypaste.png",
                "attachmentSize": "18.88KB",
                "attachmentResId": "4f7955b7-aff1-4527-bcc8-156558b2ce13",
                "userId": 127586
            }
        }
    ]
}

13 群发消息

接口名:
http://ip:端口/lop/mass/message/send? access_token=ACCESS_TOKEN
接口描述:
发送群消息
http请求方式:POST/GET,POST一个JSON数据包发送消息,和发送私信类似。
request参数对象:
参数 是否必须 描述
access_token 调用接口凭证
response参数对象:
参数 描述
errcode 请求状态
errmsg 请求信息
返回数据示例:
l) 成功返回:
{
    "errcode": 0,
    "errmsg":"请求成功"
}
消息体对象
参数 描述
tousers 多个接收方手机号,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toqun 可以在利用已有群完成群发,填写群ID
toall true:群发给整个组织;false:按照tousers、togroups群发
msgtype 消息类型:text
content 文本消息内容
示例数据
{
    "toall": true,
    "tousers": ["手机号1","手机号2"],
    "togroups": ["分支1","分支2"],
   "toqun" : "Qun-1234",
    "msgtype": "text",
    "text": {
        "content": "Hello World"
    }
}

支持图片、音频、视频、office文件等附件消息。

消息体对象
参数 描述
tousers 多个接收方手机号,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toall true:群发给整个组织;false:按照tousers、togroups群发
toqun 可以在利用已有群完成群发,填写群ID
msgtype 消息类型:attachment
media_id 附件资源文件ID
示例数据
{
    "toall": true,
    "tousers": ["手机号1","手机号2"],
    "togroups": ["分支1","分支2"],
   "toqun" : "Qun-1234",
    "msgtype": "attachment",
    "attachment": {
        "media_id": "MEDIA_ID"
    }
}
消息体对象
参数 描述
tousers 多个接收方手机号,多个以“,”间隔
togroups 多个接收方分支ID,多个以“,”间隔
toqun 可以在利用已有群完成群发,填写群ID
toall true:群发给整个组织;false:按照tousers、togroups群发
msgtype 消息类型:link
url 链接地址
示例数据
{
    "toall": true,
    "tousers": ["手机号1","手机号2"],
    "togroups": ["分支1","分支2"],
   "toqun" : "Qun-1234",
    "msgtype": "link",
    "link": {
        "url": "http://www.lanxin.cn"
    }
}

图文消息条数限制在10条以内,注意,如果图文数超过10,则将会无响应。

消息体对象
参数 是否必须 描述
tousers 多个接收方手机号,多个以“,”间隔,tousers和togroups二者至少有一个
togroups 多个接收方分支ID,多个以“,”间隔
toall true:群发给整个组织;false:按照tousers、togroups群发
msgtype 消息类型:news
title 图文标题
description 描述
url 点击后跳转的链接
picurl 图文消息的图片链接
type 图文消息链接类型,默认值为0:0 URL;1 语音; 2 视频; 3 文档 ; 4 未知
flag int类型:0 默认值,可以不传;

1. 访问link的时候增加name和telephone要求以_ckey为可以传递。例如:http://host/path/uri?_ckey=base64(name=name&telephone=telephon)
示例数据
{
    "toall": true,
    "tousers": ["手机号1","手机号2"],
    "togroups": ["分支1","分支2"],
    "toqun" : "Qun-1234",
    "msgtype": "news",
    "news": {
        "articles": [
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            },
            {
                "title": "Happy Day",
                "description": "Is Really A Happy Day",
                "url": "URL",
                "picurl": "PIC_URL",
                "type": 0,
                "flag": 0
            }
        ]
    }
}
©  2012  wqapp.cn  京ICP证100983号京ICP备12003277号-1|服务条款|隐私政策