Webservice方法-ImportContactByGroupSimple接口

来自亿业科技接口
跳转至: 导航搜索

介绍

调用本接口可以将待发送的联系人导入到平台中;
方法声明如下:

public EaseyeDetailedResultReturnDTO ImportContactByGroupSimple(EaseyeUserAccountDTO easeyeUserAccountDTO,
string groupname, list<string> emails)

输入

  • EaseyeUserAccountDTO:easeyeUserAccountDTO
用户帐户信息(必填),其字段详细信息如下:
Index Field Type Desc 最佳实践
1 Email 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. 联系组名称最好和任务名称相同,通过任务名称的唯一性来确保联系组名称的唯一性;
  2. 如果联系人较多,请循环导入;一般来说,建议每批次导入的联系人最好不要超过1万人;