异步通讯录id转译

POST

http://127.0.0.1/cgi-bin/service/contact/id_translate

第三方应用开发/通讯录管理/通讯录ID转译

最后修改时间：2022-08-30 03:03:36

责任人：未设置

注：若生成的文件不需要压缩，则 media_id_list列表只能指定一项，同时 output_file_name 不需要传值

权限说明：

只替换服务商通讯录权限范围内的用户userid跟部门id。

常见问题：

使用 NodeJs 第三方库 exceljs 生成的 excel 文件，文件内容看上去正常，但是转义不成功

原因：exceljs 在不开启 sharedString 的情况下，会默认使用 formula string 进行文件内容写入，这种行为不合规范，导致转义失败

解决方法：查看 exceljs 文档，强制开启 useSharedStrings 选项

请求参数

Query 参数

provider_access_token

string

必需

服务商provider_access_token，获取方法参见服务商的凭证

示例值:

Body 参数application/json

output_file_name

string

可选

转译完打包的文件名，不需带后缀。企业微信后台会打包成zip压缩文件，并自动拼接上.zip后缀。若media_id_list中文件个数大于1，则该字段必填。若media_id_list中文件个数等于1，且未填该字段，则转译完不打包成压缩文件。支持id转译，参见模版语法

media_id_list

array[string]

必需

需要转译的文件的media_id列表，只支持xls/xlsx，doc/docx，csv，txt文件。不超过20个文件，获取方式参考上传需要转译的文件

auth_corpid

string

必需

授权企业corpid

output_file_format

string

可选

当前仅支持输出文件为pdf格式。若media_ id_ list中文件存在相同前缀名的文件，则输出文件命名规则为：文件前缀名_ 文件格式后缀.pdf，例如：20200901_ xlsx.pdf

示例

{
  "auth_corpid": "wwxxxx",
  "media_id_list": [
    "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0"
  ],
  "output_file_name": "学习手册",
  "output_file_format": "pdf"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/service/contact/id_translate?provider_access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth_corpid": "wwxxxx",
    "media_id_list": [
        "1G6nrLmr5EC3MMb_-zK1dDdzmd0p7cNliYu9V5w7o8K0"
    ],
    "output_file_name": "学习手册",
    "output_file_format": "pdf"
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

jobid

string

可选

异步任务id，最大长度为64字节。jobid用于接口获取异步任务结果传递

errmsg

string

可选

对返回码的文本描述内容

示例

{
  "errcode": 0,
  "jobid": "string",
  "errmsg": "string"
}

上传需要转译的文件

获取异步任务结果