Benchmark Email API 版本 1.0
连结键与参数

支持返回格式的连结键皆相同,不过您可以使用这个:

关于XML-RPC,请连结以下网址:
http://api.benchmarkemail.com/1.0/


 

版本1.0
电子邮件相关方法  
static string emailCopy (string token, string emailid)
复制现有的电子邮件并回报新建立的电子邮件 ID。
static string emailCreate (string token, array emailDetails)
建立新的电子邮件,并回报新建立的电子邮件 ID。
static string emailRssCreate (string token, array emailDetails)
建立新的 RSS 电子邮件,并回报新建立的 RSS 电子邮件 ID。
static bool emailDelete (string token, string emailID)
删除ID名下的电子邮件。电子邮件确认删除后,回报 true。
static array emailGet ( string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder )
使用 filter 和 paging limits 得到电子邮件列表,并依名称或日期排序。
static array emailRssGet ( string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder )
使用 filter 和 paging limits 得到 RSS 电子邮件列表,并依名称或日期排序。
static array emailRssGetDetail (string token, string emailID)
取得 ID 名下的 RSS 电子邮件详细数据。
static array emailGetList (string token, string emailID)
Get the list of contact lists being used in an email.
static bool emailSchedule (string token, string emailID, string scheduleDate )
设定电子邮件的传送日期。
static bool emailRssSchedule (string token, string emailID, string scheduleDate, string interval )
设定 RSS 电子邮件的传送日期。
static bool emailSendNow (string token, string emailID)
实时传送电子邮件。
static bool emailSendTest (string token, string emailID, string testEmail)
传送 ID 名下的电子邮件测试信。
static bool emailUnSchedule (string token, string emailID)
将电子邮件设为草稿。这将清除电子邮件的设定时程纪录。
static bool emailUpdate (string token,array emailDetails)
更新现有的电子邮件。
static bool emailRssUpdate (string token,array emailDetails)
更新现有的电子邮件。
static bool emailAssignList (string token, string emailID, array contacts)
指定电子邮件的联络人或联络人分类群组。
static bool emailReassignList (string token, string emailID, array contacts)
重新指定电子邮件的联络人或联络人分类群组。
static string emailResend (string token, string emailID,string scheduleDate)
重新寄送电子邮件给上次寄送后新增的联络人。
static string emailQuickSend (string token, string emailID , string ListName , array emails , string scheduleDate)
快速寄送电子邮件给指定的联络人群组。
static array emailCategoryGetList (string token)
取得所有可用的电子邮件分类模板。
static string autoresponderCreate (string token, array Autoresponder)
建立自动回复电子报内容。
static bool autoresponderUpdate (string token, int status , array Autoresponder)
更新自动回复电子报内容。
static bool autoresponderDelete (string token , string autoresponderID )
删除自动回复电子报内容。
static bool autoresponderDetailDelete (string token , string autoresponderID , string autoresponderDetailID )
删除自动回复电子邮件。
static array autoresponderGetList ( string token, integer pageNumber, integer pageSize, string orderBy , string filter , string sortOrder )
使用 filter 和 paging limits 取得自动回复电子邮件列表,并依名称或日期排序。
static array autoresponderGetEmailDetail (string token , string autoresponderID , string autoresponderDetailID )
取得自动回复电子邮件的详细信息。
static array autoresponderGetDetail (string token , string autoresponderID )
取得自动回复的详细信息。
static string autoresponderDetailCreate (string token, array AutoresponderDetail)
建立新的自动回复模板,并回报新建立的自动回复模板 ID。
联络人群组相关方法  
static integer listAddContacts (string token, string listID, array contacts)
在确认之后,将联络人信息加入给定的联络人群组。若信息有超过一个以上的对象,则联络人会被多重加入。
static array listAddContactsRetID (string token, string listID, array contacts)
Add the contact details to the given contact list and returns contacts ID's in CSV format.
static integer listAddContactsOptin (string token, string listID, array contacts, string optin)
在确认之后,将联络人信息加入给定的联络人群组。若信息有超过一个以上的对象,则联络人会被多重加入。
static string listCreate (string token, string listName)
在给定的名称下建立新联络人群组。将ID回报新建立的联络人群组。
static bool listDelete (string token, string listID)
删除联络人群组。
static array listSearchContacts (string token, string emailID)
在给定的电子邮件ID下找出联络人信息。
static array listGet (string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits和filter找出联络人群组,并依姓名或日期排序。
static array listGetContactDetails (string token, string listID, string email)
在给定的电子邮件信箱下,从联络人群组中找到联络人信息。
static array listGetContacts (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用filter和paging limits在给定的联络人群组中找到联络人名单,并依电子邮件或日期排序。
static array listGetContactsAllFields (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用filter和paging limits在给定的联络人群组中找到联络人名单,并依电子邮件或日期排序。
static array listGetContactsByType (string token, string listID, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder, string Type)
使用filter和paging limits,在给定的联络人群组中找到特定类型的名单(自愿加入、非自愿加入、确认退件、有效或取消订阅),并依电子邮件或日期排序。
static array listUpdateContactDetails (string token, string listID, string contactID, array contactDetail)
根据给定的信息更新名单中的联络人信息。
static integer listUnsubscribeContacts (string token, string listID, array contacts)
在给定的联络人群组中将联络人取消订阅。
static bool listDeleteContacts (string token, string listID, string contactids)
在给定的联络人群组中删除联络人。
static bool listDeleteEmailContact (string token, string listID, string email)
删除符合给定的联络人群组中电子邮件信箱的联络人。
static integer listAddContactsForm (string token, string signupFormID, array contacts)
以给定的登录表格新增联络人。
static string segmentCreate (string token, array segmentDetail)
根据给定的资料建立新的再分类群组。
static bool segmentDelete (string token, string segmentID)
根据给定的ID删除再分类群组。
static array segmentGet (string token, string filter, int pageNumber, int pageSize, string orderBy)
使用paging limits取得再分类群组名单,并依姓名或日期排序。
static array segmentGetDetail (string token, string segmentID)
根据再分类群组的ID取得再分类群组的信息。
static array segmentGetCriteriaList (string token, string segmentID)
取得再分类群组的分类条件列表
static string segmentCreateCriteria (string token, string segmentID, array segmentCriteria)
建立再分类条件
static string segmentGetContacts (string token, string segmentID, string filter, int pageNumber, int pageSize, string orderBy, string sortOrder)
取得再分类群组名单
static int segmentGetCount (string token, string filter)
取得再分类群组的数量
分析报告相关方法  
static array reportGet (string token, string filter, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用filter和paging limits取得已传送的电子报列表,并依名称或日期排序。
static array reportGetBounces (string token, string emailID, integer pageNumber, integer pageSize, string Filter,string orderBy,string sortOrder)
使用paging limits取得特定电子报的退件名单,并依电子邮件信箱或日期排序。
static array reportGetClicks (string token, string emailID)
取得给定的电子报的点击URL统计数据。
static array reportGetClickEmails (string token, string emailID,string ClickURL, int PageNumber, int pageSize, string orderBy, string sortOrder)
取得特定电子报的点击URL电子邮件名单。
static array reportGetForwards (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits取得收到被转寄的特定电子邮件的收件人信箱,并依电子邮件信箱或转寄日期排序。
static array reportGetHardBounces (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits取得硬退件特定的电子邮件的收件人信箱,并依电子邮件信箱或被硬退件的时间排序。
static array reportGetSoftBounces (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits取得软退件特定的电子邮件的收件人信箱,并依电子邮件信箱或被软退件的时间排序。
static array reportGetOpens (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用 paging limits 取得已开启特定电子邮件的收件人信箱,并依信箱或开启日期排序。
static array reportGetUnopens (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits取得未开启亦未退件特定电子邮件的电子邮件收件人信箱,并依信箱或开启日期排序。
static array reportGetUnsubscribes (string token, string emailID, integer pageNumber, integer pageSize, string orderBy, string sortOrder)
使用paging limits 取得取消订阅特定电子邮件的收件人信箱,并依信箱或取消订阅的日期排序。
static array reportGetSummary (string token, string emailID)
取得给定电子邮件的整体数据。
static array reportCompare (string token, string emailIDs)
取得一封以上电子邮件的整体数据。
static array reportGetOpenCountry (string token, string emailID)
取得特定国家的地区代码和开启数量清单。
static array reportGetOpenForCountry (string token, string emailID,string CountryCode)
重新取得特定国家中各地区的开启数。
问卷调查方法  
static string surveyCreate (string token, SurveyStructure surveyData)
依据给定的数据建立新问卷调查。回报新问卷调查的ID。
static string surveyUpdate (string token,string SurveyID, SurveyStructure surveyData)
根据给定的资料更新既有的问卷调查。回报更新的问卷调查ID。
static string surveyDelete (string token, string SurveyID)
根据给定的资料删除问卷调查。回报删除的问卷调查ID。
static string surveyQuestionCreate (string token,string SurveyID, SurveyQuestionStructure surveyQuestionData)
根据给定的资料建立新的问卷调查问题。回报新问卷调查问题的ID。
static string surveyQuestionDelete (string token, string SurveyID, string QuestionID)
根据给定的资料删除问卷调查问题。回报删除的问卷调查问题ID。
static string surveyQuestionUpdate (string token, string SurveyID, SurveyQuestionStructure surveyQuestionData)
根据给定的资料更新问卷调查问题。回报新的问卷调查问题ID。
static string surveyColorUpdate (string token, string SurveyID, SurveyColorStructure surveyColorData)
根据给定的资料更新问卷调查的颜色。回报更新的问卷调查ID。
static integer surveyStatusUpdate (string token, string SurveyID, string Status)
根据给定的资料更新问卷调查的状态。若问卷调查已更新回报1,否则回报0。
static array surveyGetList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
利用filter和paging limits取得问卷调查清单,根据名称或日期排序。
static array surveyGetColor (string token, string SurveyID)
取得问卷调查的颜色。
static array surveyGetQuestionList (string token, string SurveyID)
产生所有可用问卷调查问题的分析报告。
static array surveyReportList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
取得问卷调查的分析报告。
static array surveyResponseReport (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
取得包含问卷调查答案和响应的清单。
static array surveyTemplateGetList (string token)
提供所有可用的问卷调查范本。
static string surveyCopy (string token,string SurveyID,string NewSurveyName)
利用既有的问卷调查建立新的问卷调查。回报新建立的问卷调查ID。
static string surveyCopyTemplate (string token,string SurveyID,string NewSurveyName)
使用既有的问卷调查模板建立新的问卷调查。回报新建立的问卷调查ID。
在线票选方法  
static string pollCreate (string token, PollStructure pollData)
根据给定的资料建立新在线票选。回报新建立的在线票选ID。
static string pollUpdate (string token,string PollID, PollStructure pollData)
根据给定的资料更新既有的在线票选。回报更新的在线票选ID。
static string pollDelete (string token, string PollID)
根据给定的资料删除既有的在线票选。回报删除的在线票选ID。
static integer pollStatusUpdate (string token, string PollID, string Status)
根据给定的资料更新在线票选状态。若在线票选已更新回报1,否则回报0。
static array pollGetList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
使用filter和paging limits取得在线票选清单,根据名称或日期排序。
static string pollCopy (string token,string PollID,string NewPollName)
使用既有的在线票选建立新在线票选。回报新建立的在线票选ID。
static array pollReportList (string token, string filter, string status, int pagenumber, int pagesize, string orderBy, string sortOrder)
产生所有可用在线票选的分析报告。
static array pollResponseReport (string token, string PollID)
取得在线票选的选项响应列表。
影音走廊方法  
static Boolean videoCreate (string token, VideoGalleryStructure videoStructure)
新增影片。若影片嵌入回报true,若否则回报false。
static string videoDelete (string token,string VideoID)
删除影片。回报删除的影片ID。
static array videoGetList (string token, int pagenumber, int pagesize)
使用paging limits取得影片列表。
登录表格方法  
static string signupFormCreate (string token, SignupFormDataStructure signupForm)
根据给定的数据建立新的登录表格。回报新建立的登录表格ID。
static bool signupFormUpdateColor (string token,string signupFormID, SignupFormColorStructure signupForm)
根据给定的数据更新既有登录表格的颜色、背景和字型。若表格已更新回报true,若否则回报false。
static bool signupFormUpdate (string token,string signupFormID, SignupFormDataStructure signupForm)
根据给定的数据更新既有的登录表格。若若已更新回报true。
static bool signupFormUpdateMessage (string token,string signupFormID, SignupFormDataStructure signupForm)
根据给定的数据更新既有登录表格的自定义字段。或已更新回报true。
static array signupFormGet (string token,string signupFormID)
根据给定的资料重新取得既有的登录表格。回报登录表格数据架构
static string signupFormGetCode (string token, string signupFormID, string Codetype)
根据给定的资料重新取得既有的登录表格代码。将代码以附带条件回报。
static bool signupFormDelete (string token, string signupFormID)
根据给定的数据删除既有的登录表格。若已删除回报true,若否则回报false。
static array listGetSignupForms (string token, integer pageNumber, integer pageSize, string orderBy)
使用paging limit 取得登录表格列表,依名称或日期排序。
图库方法  
static Boolean imageAdd (string token, ImageData imgdata)
新增图片。若图片已加入回报true,否则回报false。
static Boolean imageDelete (string token,string ImageID)
删除图片。若图片已删除回报true,否则回报例外值。
static array imageGetList (string token, int pagenumber, int pagesize)
取得图库中的图片列表。
static array imageGet (string token, string imageID)
取得图片信息。回报图片数据。
static Integer imageGetCount (string token)
取得图库中的图片数量。回报图片数量。
使用者管理方法。  
static string login (string username, string password)
认证使用者并回报token
static bool tokenAdd (string username, string password, string token)
为使用者新增token
static bool tokenDelete (string username, string password, string token)
删除使用者token
static integer subAccountCreate ( string token, array accountstruct)
为使用者注册新的子账户
static integer subAccountUpdate ( string token, array accountstruct)
为用户更新子帐户数据
static array subAccountGetList ( string token)
G为使用者取得子账户列表
subAccountUpdateStatus ( string token, string ID , string status )
为使用者更新子账户状态
static array confirmEmailList ( string token)
取得用户发送的认证信清单
static string confirmEmailAdd ( string token, string targetEmailID)
为使用者新增认证信箱
Webhook Related Methods  
static string webhookCreate (string token, array webhookDetails)
Create a new Webhook based on the details provided. Return the ID of the newly created Webhook.
static bool webhookDelete (string token, string webhookID)
Delete the Webhook for given ID. Returns true if the webhook was deleted.
static array webhookGet ( string token, string listID )
Get the list of webhook using the listID of the contact list.
static bool webhookUpdate (string token,array webhookDetails)
Update an existing webhook with the given details.