非同期タスクAPIの説明

非同期タスクAPIは、一括データ処理に利用します、呼出し後、APIはそく結果を返しましますが、企業号は、バックグラウンドでタスクを実行し続けます。実行完了後、タスクイベントを通じで、結果を取得します。エベントの内容は、暗号化されてます。暗号化処理は、(メッセージ受取時の解読処理）を参考にしてください。タスクイベントは、（非同期タスク完了イベント送信）を参考にしてください。現時点では、非同期タスクのAPIは、"ユーザリスト更新"APIのみ対応しています。

ユーザリスト更新

ユーザリスト更新APIは、3種類、1) ユーザ追加・更新 2) ユーザ全入れ替え 3) 部門全入れ替え。です。もし企業号のユーザリストが完全一致するのであれば、先に部門全入れ替えAPIを実行後、ユーザ全入れ替えを実行することで、ユーザリストと完全一致します

利用STEPは下記となります

1.csvテンプレートをダウンロードします。もし拡張フィールドがある場合は、追加します。
2.テンプレートに基づいて、ファイルを用意します。
3.メディアファイルAPIを利用して、アップロードし、media_idを取得します。
4.ユーザリストAPIを実行します
5.タスク完了イベントを受け取って、実行結果を取得します。

ユーザ追加・更新

API説明

本APIはuseridを主キーとして、ユーザリストにユーザの追加・更新を行います。CSVテンプレートをダウンロードしてください。
注意事項：

1. テンプレートの部門は部門IDです。複数所属の場合は;セミコロンで区切ってください。部門IDは数字です。
2. ファイルに存在し、ユーザリストにも存在するユーザは、指定された値で更新されます。
3. ファイルに存在し、ユーザリストに存在しないユーザは、追加されます。
4. ユーザリストの存在し、ファイルに存在しないユーザは、変更されません
5. ユーザフィールドの更新規則は、ファイル内に指定したフィールドがあり、値が正しいことです。指定外のフィールドは更新しません。

リクエスト説明

HTTPSりクエスト方式: POST
https://qyapi.weixin.qq.com/cgi-bin/batch/syncuser?access_token=ACCESS_TOKEN
リクエストボディ：

{
	"media_id":"xxxxxx",
	"callback":
	{
	 	"url": "xxx",
	 	"token": "xxx",
	 	"encodingaeskey": "xxx"
	}
}

パラメータ説明

パラメータ	必須	説明
media_id	Y	CSVファイルのメディアID
callback	N	コールバック情報。もし存在する場合は、タスク完了後、イベントを送信します。。具体的には、コールバック方式のオプションを参考にしてください。
url	N	送信先URL。httpまたはhttps.
token	N	署名。任意
encodingaeskey	N	暗号化Key。AES方式でBase64エンコード

権限説明

管理グループがすべてのユーザ管理権限を持っている事。

レスポンス結果

{
	"errcode": 0,
	"errmsg": "ok",
	"jobid": "xxxxx"
}

パラメータ	説明
errcode	エラーコード
errmsg	エラーメッセージ
jobid	非同期タスクID。最大64バイト

ユーザ全入れ替え

API説明

本APIはuseridを主キーとして、ユーザリストを全入れ替えします、タスク完了後はユーザリストとファイルが完全一致します。CSVテンプレートをダウンロードしてください。
注意事項：

1. テンプレートの部門は部門IDです。複数所属の場合は;セミコロンで区切ってください。部門IDは数字です。
2. ファイルに存在し、ユーザリストにも存在するユーザは、指定された値で更新されます。
3. ファイルに存在し、ユーザリストに存在しないユーザは、追加されます。
4. ユーザリストの存在し、ファイルに存在しないユーザは、削除されます。もし
50以上のユーザを削除する場合は、実際人数の20%以上であること
50以下のユーザを削除する場合は、実際人数の80%以上であること
5. ユーザフィールドの更新規則は、ファイル内に指定したフィールドがあり、値が正しいことです。指定外のフィールドは更新しません。

リクエスト説明

HTTPSりクエスト方式: POST
https://qyapi.weixin.qq.com/cgi-bin/batch/replaceuser?access_token=ACCESS_TOKEN
リクエストボディ：

{
	"media_id":"xxxxxx",
	"callback":
	{
	 	"url": "xxx",
	 	"token": "xxx",
	 	"encodingaeskey": "xxx"
	}
}

パラメータ説明

パラメータ	必須	説明
media_id	Y	CSVファイルのメディアID
callback	N	コールバック情報。もし存在する場合は、タスク完了後、イベントを送信します。。具体的には、コールバック方式のオプションを参考にしてください。
url	N	送信先URL。httpまたはhttps.
token	N	署名。任意
encodingaeskey	N	暗号化Key。AES方式でBase64エンコード

権限説明

管理グループがすべてのユーザ管理権限を持っている事。

レスポンス結果

{
	"errcode": 0,
	"errmsg": "ok",
	"jobid": "xxxxx"
}

パラメータ	説明
errcode	エラーコード
errmsg	エラーメッセージ
jobid	非同期タスクID。最大64バイト

組織全入れ替え

API説明

本APIはpartyidを主キーとして、組織を全入れ替えします、タスク完了後は組織とファイルが完全一致します。CSVテンプレートをダウンロードしてください。
注意事項：

1. ファイルに存在し、ユーザリストにも存在するユーザは、指定された値で更新されます。
2. ファイルに存在し、ユーザリストに存在しないユーザは、追加されます。
3. ユーザリストの存在し、ファイルに存在しないユーザは、削除されます。 4. CSVファイルには、部門名称、部門ID、親部門IDが必須です。部門IDは数字です。表示順はオプションです。空白から0の場合は変更しません。

リクエスト説明

HTTPSりクエスト方式: POST
https://qyapi.weixin.qq.com/cgi-bin/batch/replaceparty?access_token=ACCESS_TOKEN
リクエストボディ：

{
	"media_id":"xxxxxx",
	"callback":
	{
	 	"url": "xxx",
	 	"token": "xxx",
	 	"encodingaeskey": "xxx"
	}
}

パラメータ説明

パラメータ	必須	説明
media_id	Y	CSVファイルのメディアID
callback	N	コールバック情報。もし存在する場合は、タスク完了後、イベントを送信します。。具体的には、コールバック方式のオプションを参考にしてください。
url	N	送信先URL。httpまたはhttps.
token	N	署名。任意
encodingaeskey	N	暗号化Key。AES方式でBase64エンコード

権限説明

管理グループがすべてのユーザ管理権限を持っている事。

レスポンス結果

{
	"errcode": 0,
	"errmsg": "ok",
	"jobid": "xxxxx"
}

パラメータ	説明
errcode	エラーコード
errmsg	エラーメッセージ
jobid	非同期タスクID。最大64バイト

非同期タスクの結果取得

リクエスト説明

HTTPSりクエスト方式: GET
https://qyapi.weixin.qq.com/cgi-bin/batch/getresult?access_token=ACCESS_TOKEN&jobid=JOBID

パラメータ説明

パラメータ	必須	説明
access_token	Y	Access Token
jobid	Y	非同期タスクID.最大64バイト

権限説明

管理グループがすべてのユーザ管理権限を持っている事。

レスポンス結果

{
	"errcode": 0,
 	"errmsg": "ok",
	"status": 1,
	"type": "replace_user",
	"total": 3,
	"percentage": 33,
	"remaintime": 1,
	"result": [{},{}]
}

パラメータ	説明
errcode	エラーコード
errmsg	エラーメッセージ
status	タスク状態。整数。1:タスク開始、2:タスク実行中、3:タスク完了
type	タスクタイプ。文字列 sync_user:ユーザリスト更新 replace_user:ユーザリスト全入れ替え replace_party:部署全入れ替え
total	総処理件数
percentage	処理進捗率。完了時は100。
remaintime	推定残処理時間（分）。完了時は0
result	詳細処理結果。下記記載。

result内容：type=sync_user、replace_user

	"result": [
	{
	 	"action":1,
	 	"userid":"lisi",
	 	"errcode":0,
	 	"errmsg":"ok"
	},
	{
	 	"action":1,
	 	"userid":"zhangsan",
	 	"errcode":0,
	 	"errmsg":"ok"
	}
	]

パラメータ	説明
action	操作種類。1 修正，2 新規
userid	UserID。
errcode	エラーコード
errmsg	エラーメッセージ

result内容：type=replace_party

	"result": [
	{
	 	"action":1,
	 	"partyid":1,
	 	"errcode":0,
	 	"errmsg":"ok"
	},
	{
	 	"action":4,
	 	"partyid":2,
	 	"errcode":0,
	 	"errmsg":"ok"
	}
	]

パラメータ	説明
action	操作種類。1 新規作成，2 部門名変更， 4 部門移動， 8 表示順修正
partyid	部署ID
errcode	エラーコード
errmsg	エラーメッセージ

2016.11