Webservice方法-CancelMaillist接口
介绍
调用本接口可以取消某个正在审核中的列表,或者某个定时发送的,尚未发送的列表;
方法声明如下:
public EaseyeDetailedResultReturnDTO CancelMaillist(EaseyeUserAccountDTO easeyeUserAccountDTO, string mailListName)
输入
- EaseyeUserAccountDTO:easeyeUserAccountDTO
- 用户帐户信息(必填),其字段详细信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | string(50) | 用户名(必填) | |
2 | Password | string(50) | 密码(必填) |
注:1)Email是用户名,也就是平台的登录帐号;
- string:mailListName
- 待取消发送的列表名称(必填);
处理
根据列表名称找到正在发送的列表,然后判断其状态是否允许取消,如果允许,取消该列表的发送,返回成功,否则,返回失败;
当且仅当列表状态处于如下的某一种状态时,方可取消;
列表当前状态为审核中;
- 列表为定时发送的列表,且当前时间未到该列表的保护时间内(保护时间是指,在
- 该列表即将发送时,不允许取消发送。目前保护时间定义为计划发送时间的前2分钟;也就是说,如果某个列表定时凌晨5:00发送,那么凌晨4:58分后就不能取消了)
输出
- EaseyeDetailedResultReturnDTO
- 导入联系人返回信息,其字段详细信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | ErrorCode | Int | 错误码,3位整数, 2xx:处理成功; 3xx:部分成功; 4xx:临时错误; 5xx:永久错误 |
2 | ErrorInfo | string | 发生临时错误和永久 错误时,携带失败的原因 |
注:1)判断是否成功的标准取决于ErrorCode,其取值范围和取值含义见它的描述;
2)一般来说,临时失败(4xx)建议等待一个随机时间后重试,可设定最大重试次数;重试若干次如果仍然失败,通知管理员联系我方,同时将ErrorInfo的
值记录下来,一并告知我方;
3)永久失败(5xx)不建议重试,发生5xx时,通知管理员联系我方,同时将ErrorInfo的值记录下来,一并告知我方;
- 常见调用失败情况
- (4xx):列表处于定时发送的保护时间范围;
- (4xx):数据库操作失败;
- (5xx):某个字段长度不符合定义;
- (5xx):某个必须的字段缺失;
- (5xx):列表不存在,或列表状态非审核状态或者定时发送状态;