利用 HttpClient 插件整合外部消息

链接

• 通过这个步骤，我们创建了一个企业群聊，可以获得一个群聊 id(chatid)。
• 设置应用的可见范围是根目录，没有设置会返回 errcode(60011)。可以到应用管理找到这个自建应用，单击这个应用，会跳转到这个应用的详情页面，可以在这个页面编辑这个应用的可见范围。
• 首先需要有由第二个步骤获得的 access_token。

请注意，如果返回的 json 正文的 errcode 的值为 40014，则表明 access_token 过期了，需要重新到第二个步骤重新获取 access_token。

• 请求方式： POST（HTTPS）

  请求地址： https://qyapi.weixin.qq.com/cgi-bin/appchat/create?access_token=ACCESS_TOKEN

  请求参数：http正文json格式

      {"name" : "NAME","owner" : "userid1","userlist" : ["userid1", "userid2", "userid3"],"chatid" : "CHATID"}

  这里使用 httpClient 中的函数 httpPost(url,params,timeout,headers)。当前步骤不需要添加 http 请求头，只填写前面 3 个参数。

  请注意，相较于http协议的 get 方法，post 方法的参数都是放在请求正文中的，httpPost 方法的 param 参数是填写在 http 报文中的正文部分。在这里，我们需要自行补充完整 url。

• url 需要填写 'https://qyapi.weixin.qq.com/cgi-bin/appchat/create?access_token=ACCESS_TOKEN'。access_token的值(ACCESS_TOKEN)由第二个步骤获得。

• param 填写上面的 json 格式，每一个参数值都需要更替为实际参数。

  • name：群聊名字。
  • owner：群主id。
  • userlist：群成员id(userid)列表。每个成员都有唯一的userid。在企业微信网页，管理后台->“通讯录”->点进某个成员的详情页，可以看到。
  • chatid：群聊标识id。可以指定，也可以不填让系统随机创建，允许字符0-9及字母a-z和A-Z。

• timeout为超时时间，单位为毫秒，数据类型为整型。达到超时时间后httpPost会直接返回，无论是否收到http应答报文。因为这是一个远程网络请求，超时时间最好设置为1000毫秒或以上。

示例：

填写参数 url：

其中，ACCESS_TOKEN 由第二个步骤获得，param 中每个参数都需要实际的参数。

url = 'https://qyapi.weixin.qq.com/cgi-bin/appchat/create?';
url+='access_token='+ACCESS_TOKEN;

填写参数param。"NAME","userid1","userid2","userid3","CHATID"都需要填写为实际的值。

param='{"name" : "NAME","owner" : "userid1","userlist" : ["userid1", "userid2", "userid3"]，"chatid" : "CHATID"}';

调用httpPost向企业微信发送创建群聊的请求：

ret=httpClient::httpPost(url,param,1000);
print ret['text'];

返回值ret是一个dictionary，ret['text']是响应正文。如果请求成功，返回的json格式的正文text如下：

 {
     "errcode" : 0,
     "errmsg" : "ok",
     "chatid" : "CHATID"
}

请注意，errcode 是向企业微信请求信息的错误码，如果请求成功，返回值是 0。不同于 http 协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看企业微信错误码表。

chatid 的值后面步骤需要用到。这里我们使用：

body = parseExpr(ret.text).eval();
ERRCODE=body.errcode;
CHATID=body.access_token;

就可以便捷地把 chatid 和 errcode 的值解析出来。

链接

通过这最后一个步骤，我们就可以成功地在企业微信内发送群聊信息。 首先，需要一个 access_token 还有一个群聊 id(chatid)，可以通过上一个步骤获得。

请注意，如果返回的 json 正文的 errcode 的值为 40014，则表明 access_token 过期了，需要重新到上一个步骤重新获取access_token。

• 请求方式： POST（HTTPS）

  请求地址： https://qyapi.weixin.qq.com/cgi-bin/appchat/send?access_token=ACCESS_TOKEN

  使用httpClient中的函数httpPost(url,params,timeout,headers)。这里不需要添加http请求头，只填写前面3个参数。

  请注意，相较于http协议的get方法，post方法的参数都是放在请求正文中的，httpPost方法的param参数是填写在http报文中的正文部分。在这里，需要补充完整url。

• 完整的url：

  https://qyapi.weixin.qq.com/cgi-bin/appchat/send?access_token=ACCESS_TOKEN,

  其中ACCESS_TOKEN应该替换为需要发送消息应用的access_token，由第二个步骤获取。

• 参数都是以json的格式放在post请求正文中。

  {"chatid" : "CHATID","msgtype" : "text","text" : {"content" : "这是一条测试信息"}}

  • chatid：群聊id，可由上一个步骤获得。
  • msgtype：消息类型。
  • text：消息正文。

示例：

• 需要把ACCESS_TOKEN更换成由第二个步骤获得的access_token，CHATID更换成第上一个步骤通过创建群聊获得的chatid。
• 作为示例，我们这里发送的消息类型仅是文本信息，还可以有图片信息、视频信息、语音信息等等。

填写参数 url：

url = 'https://qyapi.weixin.qq.com/cgi-bin/appchat/send?';
ACCESS_TOKEN='xxxxx';
url+='access_token='+ACCESS_TOKEN;

填写参数 param：

param='{"chatid" : "CHATID","msgtype" : "text","text" : {"content" : "这是一条测试信息"}}';

调用 httpPost 向企业微信群聊发送消息：

ret=httpClient::httpPost(url,param,1000);
print ret['text'];

如果请求成功，企业微信返回的json格式正文类似如下：

{
    "errcode" : 0,
    "errmsg" : "ok",
    "invaliduser" : "",
    "invalidparty" : "1"
}

请注意，errcode 是向企业微信请求信息的错误码，如果请求成功，返回值是 0。不同于 HTTP 协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看企业微信错误码表。

可以通过以下dolphindb脚本从json格式字符串中取出 errcode。

body = parseExpr(ret.text).eval();
ERRCODE=body.errcode;

链接

• 请求方式：GET（HTTPS）

  请求地址：https://oapi.dingtalk.com/department/list?access_token=ACCESS_TOKEN

• 需要有由第二个步骤获得的access_token。

• 参数以json的格式放在请求正文中。

{"fetch_child" : true}

• fetch_child: 是否递归部门的全部子部门

示例：

填写参数url：

url = 'https://oapi.dingtalk.com/department/list';

填写参数param,ACCESS_TOKEN需要替换为由第二个步骤获得的access_token。

param=dict(string,string);
ACCESS_TOKEN='xxxxx';
param['access_token']=ACCESS_TOKEN;

调用httpGet向钉钉发送查询部门信息的请求：

ret=httpClient::httpGet(url,param,1000);
print ret['text'];

返回值ret是一个dictionary，ret['text']是响应正文。 如果请求成功，返回的json格式的正文text类似：

{
    "errcode" : 0,"errmsg" : "ok","department" : [
        {
            "id" : 123,
            "name" : "服务端开发组",
            "parentid" : 2,
            "createDeptGroup" : false,
            "autoAddUser" : false,
            "ext" : "{\"deptNo\" : 2}"
        }
    ]
}

请注意，errcode是向钉钉开发平台请求信息的错误码，如果请求成功，返回值是0。不同于http协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看钉钉开发错误码表。

字段id的值就是部门id，后面的步骤需要用到。这里我们使用：

body = parseExpr(ret.text).eval();
DEPTID=string(body[0].id);
ERRCODE=body.errcode;

就可以便捷地把id和errcode解析出来。

链接

请求方式：GET（HTTPS）

请求地址：https://oapi.dingtalk.com/user/getDeptMember?access_token=ACCESS_TOKEN&deptId=1

• 首先我们需要有由第二个步骤获得的access_token。
• deptId是部门id，可以通过上一个步骤获得。

这里使用httpClient中的函数httpGet(url,params,timeout,headers)。不需要添加http请求头，只需要填写前3个参数。

• url只需要填写'https://oapi.dingtalk.com/user/getDeptMember'，后面的access_token和deptId参数通过httpGet方法中的param参数就可以填写。
• param是一个键值对都是string的字典。 参数access_token的值(ACCESS_TOKEN)为请求接口凭证，deptId的值为部门id，两个值都需要以字符串的形式加入到param中。
• timeout为超时时间，单位为毫秒，数据类型为整型。达到超时时间后httpGet会直接返回，无论是否收到http应答报文。因为这是一个远程网络请求，超时时间最好设置为1000毫秒或以上。

示例：

填写参数url：

url = 'https://oapi.dingtalk.com/user/getDeptMember';

填写参数param,其中ACCESS_TOKEN，DEPTID都需要替换为实际的值。

param=dict(string,string);
ACCESS_TOKEN='xxxxx';
DEPTID='xxxxx';
param['access_token']=ACCESS_TOKEN;
param['deptId']=DEPTID;

调用httpGet向钉钉发送查询部门人员信息的请求：

ret=httpClient::httpGet(url,param,1000);
print ret['text'];

返回值ret是一个dictionary，ret['text']是响应正文。如果请求成功，返回的json格式的正文ret['text']类似:

{
    "errcode" : 0,
    "errmsg" : "ok",
    "userIds" : ["1","2"]
}

列表userIds后面步骤需要用到。

请注意，errcode是向钉钉开发平台请求信息的错误码，如果请求成功，返回值是0。不同于http协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看钉钉开发错误码表。

字段id的值就是部门id，后面的步骤需要用到。这里我们使用：

body = parseExpr(ret.text).eval();
Userlds=body.userIds;
ERRCODE=body.errcode;

就可以便捷地把userIds和errcode解析出来。

链接

请求方式：POST（HTTPS）

请求地址：https://oapi.dingtalk.com/chat/create?access_token=ACCESS_TOKEN

• 对于post请求，调用钉钉接口需要有一个http请求头(Content-Type:application/json)。
• url中的ACCESS_TOKEN可以通过第二个步骤获取。
• 参数都是以json的格式放在post请求正文中。

{"name" : "groupName","owner" : "zhangsan","useridlist" : ["zxxxx","lxxxx"]}

• name：群名称。

• owner：群主userId，员工唯一标识ID；必须为该会话useridlist的成员之一。

• useridlist：群成员列表，每次最多支持40人。

这使用httpClient中的函数httpPost(url,params,timeout,headers)。需要添加一个http请求头Content-Type : application/json。

请注意，相较于http协议的get方法，post方法的参数都是放在请求正文中的，httpPost方法的param参数是填写在http报文中的正文部分。在这里，需要补充完整url。

示例:

填写参数url：

url = 'https://oapi.dingtalk.com/chat/create?';
ACCESS_TOKEN='xxxxx';
url+='access_token='+ACCESS_TOKEN;

填写参数param：

param='{"name" : "groupName","owner" : "zhangsan","useridlist" : ["zxxxx","lxxxx"]}';

填写参数header，冒号必须紧跟Content-Type，否则钉钉服务端不能识别这个http请求头。

header='Content-Type: application/json';

调用httpPost向钉钉发送创建群聊的请求：

ret=httpClient::httpPost(url,param,1000,header);
print ret['text'];

返回值ret是一个dictionary，ret['text']是响应正文。 如果请求成功，返回的json格式正文类似如下:

{   "errcode" : 0,
    "errmsg" : "ok",
    "chatid" : "chatxxxxxxxxxxxxxxxxxxx",
    "conversationTag" : 2
}

请注意，errcode是向钉钉开发平台请求信息的错误码，如果请求成功，返回值是0。不同于http协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看钉钉开发错误码表。

这里我们使用：

body = parseExpr(ret.text).eval();
ERRCODE=body.errcode;

就可以便捷地把errcode解析出来。

链接

• 请求方式：POST（HTTPS）

  请求地址：https://oapi.dingtalk.com/chat/send?access_token=ACCESS_TOKEN

• 对于post请求，调用钉钉接口需要有一个http请求头(Content-Type:application/json)。

• url中的ACCESS_TOKEN可以通过第二个步骤获取。

• 参数都是以json的格式放在post请求正文中。

{"chatid" : "xxxxx","msg" : {"msgtype" : "text","text" : {"content" : "这是一条测试信息"}}}

• chatid:群会话的id。通过创建一个群聊会话获得。可以由上一个步骤获得。
• msg:消息内容。

这里使用httpClient中的函数httpPost(url,params,timeout,headers)。需要添加一个http请求头Content-Type: application/json。

请注意，相较于http协议的get方法，post方法的参数都是放在请求正文中的，httpPost方法的param参数是填写在http报文中的正文部分。在这里，需要补充完整url。

示例:

填写参数url：

url = "https://oapi.dingtalk.com/chat/send?";
ACCESS_TOKEN='xxxxx';
url+='access_token='+ACCESS_TOKEN;

填写参数headers：

headers=dict(string,string);
headers['Content-Type']='application/json';

填写参数param：

param='{"chatid" : "xxx","msg" : {"msgtype" : "text","text" : {"content" : "这是一条测试信息"}}}';

调用httpPost向钉钉发送群聊消息的请求：

ret=httpClient::httpPost(url,param,1000,headers);
print ret['text'];

• 如果请求成功，返回的json格式正文类似如下，errcode的值为0。

{"errcode" : 0,"errmsg" : "ok","messageId" : "abcd"}

请注意，errcode是向钉钉开发平台请求信息的错误码，如果请求成功，返回值是0。不同于http协议的请求返回的响应码。如果出现其他errcode值，查看错误信息errmsg。errcode的值的含义可查看钉钉开发错误码表。

通过以下脚本就能把errcode从json格式正文中取出来。

body = parseExpr(ret.text).eval();
ERRCODE=body.errcode;