リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/extcontact/listlabelgroups |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリappType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_ext_read-企業外部連絡先の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | このAPIを呼び出すアプリ認証情報。 - 社内アプリの場合、社内アプリのaccess_token取得インターフェースから取得します。 - サードパーティ社内アプリの場合、サードパーティ企業のaccess_token取得インターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| size | Number | いいえ | 20 | ページング検索をサポートし、offsetパラメータと同時に設定された場合のみ有効になります。このパラメータはページサイズを表し、最大100です。 |
| offset | Number | いいえ | 0 | ページング検索をサポートし、sizeパラメータと同時に設定された場合のみ有効になります。このパラメータはオフセット量を表し、オフセット量は0から始まります。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/extcontact/listlabelgroups" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e6eaxxxxa401' \
-d 'offset=0' \
-d 'size=20'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
OapiExtcontactListlabelgroupsRequest req = new OapiExtcontactListlabelgroupsRequest();
req.setSize(20L);
req.setOffset(0L);
OapiExtcontactListlabelgroupsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiExtcontactListlabelgroupsRequest("https://api.dingtalk.io/topapi/extcontact/listlabelgroups")
req.size=20
req.offset=0
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiExtcontactListlabelgroupsRequest;
$req->setSize("20");
$req->setOffset("0");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/extcontact/listlabelgroups");
OapiExtcontactListlabelgroupsRequest req = new OapiExtcontactListlabelgroupsRequest();
req.Size = 20L;
req.Offset = 0L;
OapiExtcontactListlabelgroupsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| results | OpenLabelGroup[] | 検索結果。 | |
| name | String | タイプ | タグ グループの名前。 |
| color | Number | -15220075 | タグ グループの色。 |
| labels | OpenLabel[] | タグリスト。 | |
| name | String | お客様 | タグ名。 |
| id | Number | 1026002 | タグID。 |
| errcode | Number | 0 | リターンコード。 |
| request_id | String | 8n3mksu5hqzy | リクエストID。 |
レスポンスボディ例
{
"errcode":0,
"results":[
{
"color":-15220075,
"name":"タイプ",
"labels":[
{
"name":"お客様",
"id":1561077310
},
{
"name":"販売代理店",
"id":1561077311
},
{
"name":"サプライヤー",
"id":1561077312
},
{
"name":"パートナー",
"id":1561077313
},
{
"name":"面接者",
"id":1561077314
},
{
"name":"その他のタイプ",
"id":1561077315
}
]
},
{
"color":-11687445,
"name":"レベル",
"labels":[
{
"name":"一般",
"id":1561077317
},
{
"name":"重要",
"id":1561077318
},
{
"name":"コア",
"id":1561077319
}
]
},
{
"color":-543394,
"name":"ステータス",
"labels":[
{
"name":"潜在",
"id":1561077321
},
{
"name":"見込み",
"id":1561077322
},
{
"name":"商談中",
"id":1561077323
},
{
"name":"成約",
"id":1561077324
},
{
"name":"失注",
"id":1561077325
}
]
},
{
"color":-543394,
"name":"人事採用ステータス",
"labels":[
{
"name":"招待待ち",
"id":1561077327
},
{
"name":"面接待ち",
"id":1561077328
},
{
"name":"一次面接",
"id":1561077329
},
{
"name":"二次面接",
"id":1561077330
},
{
"name":"入社",
"id":1561077331
}
]
}
],
"request_id":"51jof1jt5f4t"
}
エラーコード
このインターフェースの呼び出し時にエラーが発生した場合は、エラーメッセージに基づいてグローバルエラーコードドキュメントで解決策を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 33009 | 無効なtokenGrantType | access_tokenが正しいかご確認ください |
| 400043 | 無効なorgId | access_tokenが正しいかご確認ください |
| 41101 | 無効なsize | ページサイズが正しいかご確認ください |
| 40068 | 無効なオフセット量 | オフセット量を調整してください |
| -1 | システムビジー | 後で再試行してください |