Webservice方法-ImportContactByGroupSimple接口
介紹
調用本接口可以將待發送的聯繫人導入到平台中;
方法聲明如下:
public EaseyeDetailedResultReturnDTO ImportContactByGroupSimple(EaseyeUserAccountDTO easeyeUserAccountDTO, string groupname, list<string> emails)
輸入
- EaseyeUserAccountDTO:easeyeUserAccountDTO
- 用戶帳戶信息(必填),其字段詳細信息如下:
Index | Field | Type | Desc | 最佳實踐 |
---|---|---|---|---|
1 | string(50) | 用戶名(必填) | 登錄名 | |
2 | Password | string(50) | 密碼(必填) | 接口密碼(不是人工登錄密碼) |
注:1)Email是用户名,也就是平台的登录帐号:
- string:groupname
- 待導入的聯繫組名稱(必填);
- 最佳實踐:建議設置為任務名稱,確保唯一;
注:如果该联系人组数据库中没有,则将该联系组会被新建;如果已经存在,则直接复用;
- list<string>: emails
- 待導入的郵件地址(必填);
處理
將上傳的聯繫人以導入到用戶指定的組中,同時返回導入失敗的聯繫人信息;
輸出
- EaseyeDetailedResultReturnDTO
- 導入聯繫人返回信息,其字段詳細信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | ErrorCode | Int | 錯誤碼,3位整數 2xx:處理成功; 3xx:部分成功; 4xx:臨時錯誤; 5xx:永久錯誤 |
2 | ErrorInfo | string | 發生臨時錯誤和永久錯誤時,攜帶失敗的原因 |
3 | ErrorItems | List<ErrorItem> | 導入失敗的聯繫人,當且僅當ErrorCode為3xx時本值才可以參考 |
注:1)判断是否成功的标准取决于ErrorCode,其取值范围和取值含义见它的描述;
2)一般来说,临时失败(4xx)建议等待一个随机时间后重试,可设定最大重试次数;重试若干次如果仍然失败,通知管理员联系我方,同时将ErrorInfo的
值记录下来,一并告知我方;
3)永久失败(5xx)不建议重试,发生5xx时,通知管理员联系我方,同时将ErrorInfo的值记录下来,一并告知我方;
- 其中,ErrorItem的字段信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | ErrorCode | Int | 錯誤碼,3位整數 3xx:部分成功; 4xx:臨時錯誤; 5xx:永久錯誤 |
2 | ErrorDesc | string | 本地地址導入失敗的原因 |
3 | ItemValue | string | 導入失敗的聯繫人 |
注:1)ErrorCode为4xx时,临时失败,比如数据库操作失败,您可以尝试将这些地址再次导入;
2)ErrorCode为5xx时,永久失败,往往是这些地址格式错误,不需要重试;
- 常見調用失敗情況
- (4xx):業務限制;
- (4xx):數據庫操作失敗;
- (5xx):某個字段長度不符合定義;
- (5xx):某個必須的字段缺失;
- (6xx):聯繫人Email地址格式校驗不通過;
最佳實踐
本方法過於簡單,不需要太多的指導即可完成調用;
調用時注意事項:
- 聯繫組名稱最好和任務名稱相同,通過任務名稱的唯一性來確保聯繫組名稱的唯一性;
- 如果聯繫人較多,請循環導入;一般來說,建議每批次導入的聯繫人最好不要超過1萬人;