The main advantage of APIs in Masterbase® is that they allow you to automate actions that are performed on the web platform manually. Among other things, they make it possible to:
Update your databases in your work environment and on our platform, simultaneously.
Create and send messages from your systems without having to access our platform.
Receive from MasterBase® metrics for your shipments.
Use our web services APIs to facilitate and synchronize the actions to be performed.
Before you begin, you must create the credentials that authorize you to make use of our APIs.
Integrate your company's internal systems with our platform and automate data handling.
To construct the URL of the service you want to consume, you must do so with the following structure:
Base URL that groups Contacts services:
https://api2019.masterbase.com/
o which you must first add the segment that indicates the service you are pointing to, and then the optional parameters that define your query in question. The first of these preceded by a question mark (?), followed by an equals sign and the value of the parameter. From the second parameter you need to add, you must use the ampersand (&) sign instead of the question mark.
Example:
https://api2019.masterbase.com/contacts/v2/ClientName/?From=123&Top=100&Order=1
The Envelope
Each answer is contained in a structure called envelope. This means that each response has a predefined structure with which you can interact.
{ "Service": "Service Name", "Version": "Version the service", "TransactionId": "TransactionId", "Status": { "Code": "Answer Code", "Value": "Value of response" }, "Data": {} }
Status
The status key is used to obtain information about the service response. If everything has followed its course correctly, the response will indicate in the Code attribute a value of 200 or 201. However, something may fail, in which case the response to be obtained is of this type:
"Status": { "Code": "401", "Value": "Unauthorized" }
/contacts/v2/{ClientName}/{ListId}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
ListId *
Contact base identifier.
number($string) - (path)
Email *
Email from the contact to search.
string($string) - (query)
From *
Indicates the ID of the first contact in the list.
string($string) - (query)
Top *
Indicates the number of contacts the list displays.
string($string) - (query)
Order *
Indicates the order of the list: By date of contact creation (0 ascending, 1 descending).
string($string) - (query)
(*) Mandatory parameter
Email, From, Top y Order son parámetros para incluir en el consumo de un web service. respetando las siguientes premisas:
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "idContact": "451028", "Email": "example@mail.com", "Gender": "M", "CreatedBy": "Usuario", "ModifiedBy": "Admin", "DateModification": "2018-01-17T20:23:34.193", "FieldStr01": "John", "FieldStr02": "Doe", "FieldDte01": "1900-01-01T00:00:00" } ] } } }
400
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/contacts/v2/{ClientName}/{ListId}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
ListId *
Contact base identifier.
number($integer) - (path)
Identifier *
Email or Id of the contact to be searched.
string($string) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contact": { "Email": "prueba46@prueba.cl", "Deleted": "True" } } }
400
Description
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Description
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/contacts/v2/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
ContactId *
Contact ID.
number($integer) - (query)
Order
Indicates the order in which messages will be listed: By the scheduled date.
integer - (query)
ExtraDetail
Indicates whether details of shipments made (true/false) are required.
boolean - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Response": { "PageDetail": { "TotalRecords": "340", "CurrentPage": "1", "TotalPage": "23" }, "Summary": { "TotalOpens": "45", "TotalWebViews": "1", "TotalCliks": "23", "TotalBounces": "23" }, "Mails": { "Mail": [{ "id": "1022", "Open": "2", "WebView": "1", "TotalClicks": "0", "TotalBounces": "0", "Detail": { "Links": { "Link": { "Url": "http://www.es.masterbase.com/?utm_campaign=4329:%20Ejemplo%20&utm_source=MasterBase%20Cliente&utm_medium=email&utm_content=3&utm_term=none", "Total": "1" } }, "Bounces": { "Bounce": { "Code": "133", "Total": "1" } } }, "ExtraDetail": { "Opens": { "Open": { "Country": "US", "OS": "Linux", "Patform": "Desktop", "EventDate": "2016-09-02T16:45:11" } }, "Clicks": { "Click": { "Country": "US", "OS": "Linux", "Patform": "Desktop", "EventDate": "2016-09-02T16:45:11" } } } } ] } } } }
400
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/contacts/v2/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
Update
Indicates whether you want to update contacts (true/false).
boolean - (query)
Body *
Contact details to be created or updated.
(body)
Example Value | Model
{ "Request": { "ListId": "1", "Contacts": { "Contact": [{ "Email": "example@mail.com", "Gender": "M", "FieldStr01": "John", "FieldStr02": "Doe", "FieldDte01": "1900-01-01T00:00:00" } ] } } }
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "Email": "example@mail.com", "idContact": "451028", "Validation": { "Status": "PASSED" }, "Operation": { "Status": "UPDATED", "text": "Successfully executed" } } ] } } }
400
Description
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Description
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/contacts/v2/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
Body *
Contact details update.
(body)
Example Value | Model
{ "Request": { "ListId": "1", "Contact": { "Email": "example@mail.com", "Gender": "M", "FieldStr01": "John", "FieldStr02": "Doe", "FieldDte01": "1900-01-01T00:00:00" } } }
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "Email": "example@mail.com", "idContact": "451028", "Validation": { "Status": "PASSED" }, "Operation": { "Status": "UPDATED", "text": "Successfully executed" } } ] } } }
400
Description
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Description
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/contacts/v2/{ClientName}/GetContacts/{ListId}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
ListId *
Contact base identifier.
integer($int32) - (path)
Field*
The filter field.
string - (query)
Value*
Filter value
string - (query)
Top
Indicates the number of contacts the list will display.
string($string) - (query)
Op*
Operator that will apply the filter.
string - (query)
PageNumber
Operator that will apply the filter.
string - (query)
PageSize
Number of records to display per page.
string - (query)
Order
Indicates the order in which messages will be listed: By creation date.
string - (query)
(*) Mandatory parameter
Allowed values for the operator attribute
Operator Value
Correlation
Type
eq
Same as
string - (query)
neq
Different from
string - (query)
sw
Start with
string - (query)
contain
Contains
string - (query)
notcontains
Does not contain
string - (query)
gt
Greater than
string - (query)
Lt
Less than
string - (query)
gte
Greater than or equal to
string - (query)
lte
Less the same as
string - (query)
null
Null
string - (query)
notnull
Not null
string - (query)
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "200", "Value": "OK" }, "Data": { "PageDetail": { "CurrentPage": "1", "TotalPages": "2323", "TotalRecords": "5342", "Contacts": { "Contact": [{ "idContact": "451028", "Email": "example@mail.com", "Gender": "M", "CreatedBy": "Usuario", "ModifiedBy": "Admin", "DateModification": "2018-01-17T20:23:34.193", "FieldStr01": "John", "FieldStr02": "Doe", "FieldDte01": "1900-01-01T00:00:00" } ] } } } }
400
No Data
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Code": "NoData", "Value": "No Data" } }
401
Unauthorized
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "5c60b7bcd4f5620f627d0346b796c765", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFound", "Value": "User not found" } }
500
Internal error
Example Value | Model
{ "Message": "An error has occuried" }
/massivemail/v1/{ClientName}
Parameters endpoints
Name
Description
Type
Account name. *
Name of the customer's account.
string($string) - (path)
Body *
Data of the message to be sent.
(body)
Parameters body
Classification.
Only "C" or "T" (Commercial/Transactional) values are accepted by default, Commercial is assumed.
Text
Name. *
Name of the mail.
Text
Description.
Description of the message.
Text
SubCategoryId.
Subcategory identifier.
Number
Based on Type.
It only accepts "template" value.
Text
Based on Id.
Template Id.
Number
From Type. *
Accepts only "Standard" or "Dynamic" values.
Text
From Id. *
Sender numeric identifier.
Number
ListId. *
Identifier of the contact list on which the messages will be made.
Number
FilterType. *
It only accepts "Static", "Dynamic" or "Newsletter" values.
Text
Ids. *
List of identifiers associated with the selected filter, only allows multiple identifiers the newsletter filter type.
Number
Subject. *
Subject of the message.
Text
Format. *
Accepts only "html" or "text" values.
Text
Now. *
Accepts only true or false values, assumes true value by default.
Text
OpenTracking. *
Accepts only true or false values.
Text
ClickTracking. *
Accepts only true or false values.
Text
Enable. *
Accepts only true or false values.
Text
The template used must have in the message body the tag ‹ attachfile /› and the file to attach must be preloaded on the system via File Bunker.
Example Value | Model
{ "GeneralData": { "Name": "Prueba de Envio", "Description": "Dato Opcional", "SubCategory": "1", "Classification": "C" }, "From": { "Type": "Standard", "Id": "1" }, "To": { "Ids": [ "4" ], "ListId": "1", "FilterType": "Dynamic" }, "Message": { "Subject": "Asunto del correo", "Body": { "Format": "html", "Value": "<!DOCTYPE html><html> Cuerpo del correo <html>" } }, "Options": { "SendDate": { "Now": "false", "Value": "2018-01-30T09:38:00-03:00" }, "OpenTracking": "true", "ClickTracking": "true", "Enable": "false" } }
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "Email": "example@mail.com", "idContact": "451028", "Validation": { "Status": "PASSED" }, "Operation": { "Status": "UPDATED", "text": "Successfully executed" } } ] } } }
400
Description
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Description
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}
Parameters endpoints
Name
Description
Type
Account name. *
Name of the customer's account
string($string) - (path)
Body *
Data of the message to be sent.
(body)
Parameters body
Classification.
Only "C" or "T" (Commercial/Transactional) values are accepted by default, Commercial is assumed.
Text
Name. *
Name of the message.
Text
Description.
Description of the message.
Text
SubCategoryId.
Subcategory identifier.
Number
Based on Type.
It only accepts "template" value.
Text
Based on Id.
Template ID.
Number
From Type. *
Accepts only "Standard" or "Dynamic" values.
Text
From Id. *
Sender numeric identifier.
Number
ListId. *
Identifier of the contact list on which the shipment will be made.
Number
FilterType. *
It only accepts "Static", "Dynamic" or "Newsletter" values.
Text
Ids. *
List of identifiers associated with the selected filter, only allows multiple identifiers the newsletter filter type.
Number
Subject. *
Subject of the message.
Text
Format. *
It only accepts values“html” o “text”.
Text
Now. *
Accepts only true or false values, assumes true value by default.
Text
OpenTracking. *
Accepts only true or false values.
Text
ClickTracking. *
Accepts only true or false values.
Text
Enable. *
Accepts only true or false values.
Text
The template used must have in the message body the tag ‹ attachfile /› and the file to attach must be preloaded on the system via File Bunker.
Example Value | Model
{ "GeneralData": { "Name": "Promotional mail campaign November", "Description": "Mail containing the Nov. promotional campaign", "SubCategoryId": "2", "Classification": "C", "BasedOn": { "Type": "template", "Id": "1" } }, "From": { "Type": "Standard", "Id": "1" }, "To": { "Ids": [ "1" ], "ListId": "1", "FilterType": "Newsletter" }, "Message": { "Subject": "November Campaign", "Body": { "Format": "html", "Value": "<!DOCTYPE html><html> Message body <html> " } }, " Options ": { " SendDate ": { " now ": " false ", " value ": " 2016 - 09 - 05 20: 30: 00 " }, " OpenTracking ": " false ", " ClickTracking ": " true ", " Enable ": " true " } }
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "Email": "example@mail.com", "idContact": "451028", "Validation": { "Status": "PASSED" }, "Operation": { "Status": "UPDATED", "text": "Successfully executed" } } ] } } }
400
Description
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Description
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
Body *
Data to be updated in the generated draft.
(body)
Example Value | Model
{ "GeneralData": { "MailId": "5401", "SubcategoryId": "2" }, "From": { "Type": "Standard", "Id": "1" }, "To": { "Ids": [ "4" ], "ListId": "1", "FilterType": "Dynamic" }, "Message": { "Subject": "Asunto del correo", "Body": { "Format": "html", "Value": "<!DOCTYPE html><html> Cuerpo del correo <html>" } }, "Options": { "SendDate": { "Now": "false", "Value": "2018-01-30T09:38:00-03:00" }, "OpenTracking": "true", "ClickTracking": "true", "Enabled": "false" } }
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "MailId": { "AccountStatus": "User", "Value": "10291" }, "TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df", "Status": { "Code": "200", "Value": "OK" } }
400
Description
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Description
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}/GetMail
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string($string) - (path)
MailId *
Shipping ID.
integer($int64) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Response": { "AccountTipe": "T", "MassiveMail": { "Id": "7024", "Name": "Nombre del envio", "Subject": "Asunto del envio", "Status": "E", "Creator": "email@dominio.com", "SentDate": "2017-08-09T13:25:01.717", "EnabledBy": "email@dominio.com", "EnabledDate": "2017-08-09T13:25:01.717", "Total": "1000", "CategoryId": "1", "Category": "Categoria Test", "SubCategoryId": "1", "SubCategory": "Test Interno" } }, "TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df", "Status": { "Code": "200", "Value": "OK" } }
AccountType
Type of credential that originated the message
T: Testing / Restricted P: Productive
ID
Type of credential that originated the message.
-
Name
Name assigned to the message.
-
Subject
Message Subject.
-
Status
Message Status.
E: Sent
D: Disabled
H: Enabled
Creator
Credential that created the message.
-
SentDate
Shipping date.
-
EnabledBy
Credential that enabled the message.
-
EnabledDate
Message enable date.
-
Total
Number of recipients.
-
CategoryId
Name of the category assigned to the shipment.
-
Category
Name of the category assigned to the shipment.
-
SubCategoryId
Id of the subcategory assigned to the shipment.
-
SubCategory
Name of the subcategory assigned to the shipment.
-
400
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}/GetMails
Parameters endpoints
Name
Description
Type
ClientName *
Account name.
string - (path)
PageNumber
Page number to view.
string - (query)
PageSize
Number of records per page.
string - (query)
StartDate
Start date of the list of shipments.
string - (query)
EndDate
End date of the list of shipments.
string - (query)
CategoryId
The id of the shipment category.
integer($int32) - (query)
SubCategoryId
The ID of the subcategory of the shipment.
integer($int32) - (query)
Creator
Email or credential of the send creator.
string - (query)
EnabledBy
Email or credential from the send enabler.
string - (query)
Subject
Shipping subject.
string($string) - (query)
(*) Mandatory parameter
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Response": { "AccountTipe": "T", "MassiveMail": { "Id": "7024", "Name": "Nombre del envio", "Subject": "Asunto del envio", "Status": "E", "Creator": "email@dominio.com", "SentDate": "2017-08-09T13:25:01.717", "EnabledBy": "email@dominio.com", "EnabledDate": "2017-08-09T13:25:01.717", "Total": "1000", "CategoryId": "1", "Category": "Categoria Test", "SubCategoryId": "1", "SubCategory": "Test Interno" } }, "TransactionId": "RST01_20180130_44c2af5ef1984651bf9f0aad1264b2df", "Status": { "Code": "200", "Value": "OK" } }
AccountType
Type of credential that originated the message
T: Testing / Restricted P: Productive
ID
Message numeric identifier.
-
Name
Name assigned to the message.
-
Subject
Message Subject.
-
Status
Message Status.
E: Sent
D: Disabled
H: Enabled
Creator
Credential that created the message.
-
SentDate
Submission date.
-
EnabledBy
Credential that enabled the message.
-
EnabledDate
Message enable date.
-
Total
Number of recipients.
-
CategoryId
Id of the category assigned to the shipment.
-
Category
Name of the category assigned to the email.
-
SubCategoryId
Id of the subcategory assigned to the shipment.
-
SubCategory
Name of the subcategory assigned to the message.
-
400
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}/GetStatistics
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string - (path)
MailId
Identificador del envío.
integer($int64) - (query)
PageNumber
Número de página a la vista.
string - (query)
PageSize
Cantidad de registros por página.
string - (query)
StartDate
Fecha inicial del listado de envíos.
string - (query)
EndDate
Fecha final del listado de envíos.
string - (query)
CategoryId
Identificador de la categoría del envío.
integer($int32) - (query)
SubCategoryId
Identificador de la subcategoría del envío.
integer - (query)
EnabledBy
Correo electrónico o credencial del habilitador del envío.
string($int32) - (query)
Creator
Correo electrónico o credencial del creador del envío.
string - (query)
EnabledBy
Correo electrónico o credencial del habilitador del envío.
string - (query)
Subject
Asunto del envío.
string - (query)
ExtraDetail
Indica si se obtendrá estadísticas detalladas.
boolean - (query)
Order
Indica el orden del listado: Por fecha de envío (0 ascendente, 1 descendente).
string($string) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Response": { "AccountType": "T", "CurrentPage": "1", "TotalPage": "500", "TotalRecords": "3200", "MassiveMail": { "Statistics": [{ "MailId": "10234", "Sent": "1000", "Open": "700", "OpenUnique": "450", "OpenPixelTracking": "45", "OpenWebview": "1", "OpenClicDeduced": "23", "Bounce": "2", "BounceUnique": "2", "Click": "333", "ClickUnique": "163", "NotOpen": "300", "Accepted": "689", "Acepted_Rate": "98.0000", "TAC": "75.0000", "CTR": "75.0000", "CTO": "75.0000", "ExtraDetail": { "Opens": [{ "OpenDetail": "101", "Country": "US", "OS": "Linux", "Patform": "Desktop", "EventDate": "2016-09-02T16:45:11" } ], "Links": [{ "OpenDetail": "101", "Country": "US", "OS": "Linux", "Patform": "Desktop", "EventDate": "2016-09-02T16:45:11" } ], "Bounces": [{ "OpenDetail": null, "Country": null, "OS": null, "Patform": null, "EventDate": "2016-09-02T16:45:11" } ] } } ] } }, "TransactionId": "RST04_20180201_bfb8cbfaf1ff45528b0073cbaae06805", "Status": { "Code": "200", "Value": "OK" } }
AccountType
Type of credential that originated the message
T: Testing / Restricted P: Productive
CurrentPage
Page number in view.
-
TotalPage
Total response pages.
-
TotalRecords
Total recipient boxes.
-
MailId
Message numeric identifier.
-
Sent
Number of emails made.
-
Open
Total number of open messages.
-
OpenUnique
Number of unique openings.
-
OpenPixelTracking
-
-
OpenWebview
Number of messages displayed via web.
-
OpenClicDeduced
-
-
Bounce
Total amount of bounces.
-
BounceUnique
Number of unique rebounds.
-
Click
Total number of open links.
-
ClickUnique
Number of unique open links.
-
Accepted
Number of unique open links.
-
Accepted_Rate
Message Acceptance Rate.
-
NotOpen
Number of unopened messages.
-
Accepted
Number of messages accepted.
-
Acepted_Rate
Accepted Rate.
-
TAC
Unique opening rate.
-
CTR
Unique clicks / Accepted messages = Unique Click Trough Rate.
-
CTO
Unique clicks / Pixel tracking = Unique Click To Open.
-
ExtraDetail
Extra details about the events.
Opens
Links
Bounce
OpenDetail
Code associated with the event.
-
Country
Acronym for country in which the event occurred.
-
OS
Operating system from which the event occurred.
-
Platform
Platform.
Desktop
Mobile
EventDate
Date associated with the event.
-
400
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/massivemail/v1/{ClientName}/GetEvent/{MailId}/{Event}
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string - (path)
MailId*
Identificador del envío.
integer($int64) - (path)
Event *
Tipo de evento (sent, open, click, bounce)
string - (path)
PageNumber
Número de página a la vista.
string - (query)
PageSize
Cantidad de registros por página.
string - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Response": { "CurrentPage": "1", "TotalPage": "1", "TotalRecords": "1", "Records": { "Type": "open", "Record": [ { "Email": "correo@mail.com", "EventDate": "2018-02-08T15:52:46", "OperatingSystem": "Windows 7", "Platform": "WinNT" } ] } }, "TransactionId": "RST04_20180201_bfb8cbfaf1ff45528b0073cbaae06805", "Status": { "Code": "200", "Value": "OK" } }
AccountType
Type of credential that originated the message
T: Testing / Restricted P: Productive
CurrentPage
Page number in view.
-
TotalPage
Total response pages.
-
TotalRecords
Total recipient boxes.
-
Type
Event type.
Opens
Links
Bounce
Box associated to the event.
-
EventDate
Date associated with the event.
-
OperatingSystem
Operating system from which the event occurred.
-
Platform
Platform.
Desktop
Mobile
400
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/UniqueMail/v3/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
Body *
Datos del mensaje a enviar.
(body)
Example Value | Model
{ "GeneralData": { "FromName": "Nombre Remitente", "From": "from@mail.com", "To": { "Email": [ "destinatario@mail.com" ] }, "Cc": { "Email": [ "destinatarioCC@mail.com" ] }, "Bcc": { "Email": [ "destinatarioBcc@mail.com" ] }, "Message": { "Subject": "Asunto del correo", "Classification": "T", "Body": { "Format": "html", "Value": "<!DOCTYPE html><html> Cuerpo del correo <html>" }, "Attachment": [ { "FileName": "a-b-c.csv", "Encode": "Base64", "Size": "1", "Value": "ZW1haWw7bm9tYnJlDQphQGEuY29tO2ENCmJAYi5jb207Yg0KY0BjLmNvbTtjDQo=" } ] }, "Options": { "OpenTracking": "true", "ClickTracking": "true", "TextHtmlTracking": "true", "AutoTextBody": "false" } } }
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "Mails": [{ "Id": "W1C1d18d0b1cb52e4a2fa89d19af3fe9b44601" } ] }, "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" } }
400
Description
No Data
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Code": "NoData" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFoundOrWithoutPermissions" } }
500
Description
Internal error
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Code": "GeneralException" } }
/UniqueMail/v3/{ClientName}
Parameters endpoints
Name
Description
Type
Nombre de la cuenta. *
Nombre de la cuenta del cliente.
string($string) - (path)
Body *
Datos del mensaje a enviar.
(body)
Example Value | Model
{ "GeneralData": { "FromName": "Nombre Remitente", "From": "correo@remitente.com", "To": { "Email": ["emaildestintario1@mail.com", " emaildestintario2@mail.com "] }, "Message": { "Subject": "Asunto del envio", "Classification": "C", "BasedOn": { "Id": "6", "Type": "Template" }, "Body": { "Format": "html", "Value": "obligatorio", "Variables": [{ "Name": "VariableNombre", "Value": "Claudia" }, { "Name": "VariableApellido", "Value": "Carmona" }, { "Name": "VariableCargo", "Value": "Editora de Contenidos" }, { "Name": "VariableCorreo", "Value": "example@mail.com" } ] }, "Attachment": [{ "FileName": "NombreArchivo1.ext", "Encode": "Base64", "Size": "178", "Value": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAf/9k=" }, { "FileName": "NombreArchivo2.ext", "Encode": "Base64", "Size": "165", "Value": "/9j/4AAQSkZJRgABAQAAAQABAAD//LCk/ZWo7P5SrG7hNWz+X6j8hGbTeV3r9goypgENJdfYEIgQiBCIEIgQiBCIEIgQiBCIEIgQiBC//2Q==" } ] }, "Options": { "OpenTracking": "true", "ClickTracking": "false", "TextHtmlTracking": "true", "AutoTextBody": "false", "Personalization": "true" } } }
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Service": "Contacts", "Version": "1.0.9.0", "TransactionId": "a7ef3fd03ad54fdc8394497ff6b74f9c", "Status": { "Code": "200", "Value": "OK" }, "Data": { "Contacts": { "Contact": [{ "Email": "example@mail.com", "idContact": "451028", "Validation": { "Status": "PASSED" }, "Operation": { "Status": "UPDATED", "text": "Successfully executed" } } ] } } }
400
Description
No Data
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Mensaje": { "Code": "InternalWarning" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "400", "Value": "BadRequest" } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Description
Internal error
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Error": { "Code": "InternalError" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "500", "Value": "InternalServerError" } }
/UniqueMail/v3/{ClientName}/Summary
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
MailId
Identificador del envío.
integer($int64) - (query)
PageNumber
Número de página a la vista.
integer($int64) - (query)
PageSize
Cantidad de registros a mostrar.
integer($int64) - (query)
PageSize
Cantidad de registros por página.
string - (query)
StartDate
Fecha inicial del listado de envíos.
string - (query)
EndDate
Fecha final del listado de envíos.
string - (query)
To
Dirección de correo electrónico del destinatario.
string - (query)
Order
Indica el orden del listado: Por fecha de envío (0 ascendente, 1 descendente).
integer($int32) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "PageDetail": { "TotalRecords": "1232", "CurrentPage": "1", "TotalPages": "10" }, "Mails": [{ "Id": "A16415e5cb09bea04952bb0e09e25ca6802301", "RuleId": "30", "Subject": "Asunto del mensaje", "From": "remitente@mail.com", "To": "destinatario@mail.com", "Category": "Categoria Test", "UrlEmlOriginal": "https://api.masterosr.com/out/v1/4/4/A16415e5cb09bea04952bb0e09e25ca6802301/o8bhex6cee64lxu20xmubwz7yrbxniws", "UrlEmlProced": "https://api.masterosr.com/out/v1/4/4/A16415e5cb09bea04952bb0e09e25ca6802301/2bugbxkq7f6fqs1ul7elz7lwdov71j", "ReceptionDate": "2017-11-21T15:21:23.867", "SendDate": "2017-11-21T15:19:21.51", "Status": "250" } ] }, "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Code": "NoData" } }
401
Unauthorized
Example Value | Model
{ "Service": "MassiveMail", "Version": "1.0.14.0", "Error": { "Message": { "Code": "AuthorizationFailure" } }, "TransactionId": "RST02_20180130_62875e9908484fc9a56db8bdf3d407cd", "Status": { "Code": "401", "Value": "Unauthoraized" } }
500
Internal error
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Code": "GeneralException" } }
/UniqueMail/v3/{ClientName}/Statistics
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
MailId
Identificador del envío.
integer($int64) - (query)
PageNumber
Número de página a la vista.
integer($int64) - (query)
PageSize
Cantidad de registros a mostrar.
integer($int64) - (query)
StartDate
Fecha inicial del listado de envíos.
string - (query)
EndDate
Fecha final del listado de envíos.
string - (query)
To
Dirección de correo electrónico del destinatario.
string - (query)
Order
Indica el orden del listado: Por fecha de envío (0 ascendente, 1 descendente).
integer($int32) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "PageDetail": { "TotalRecords": "1232", "CurrentPage": "1", "TotalPages": "10" }, "Summary": { "PageDetail": { "Sents": "1", "Opens": "1", "Clicks": "2", "Retries": "2", "Accepteds": "1", "AcceptedsRate": "100.0000", "TACs": "0.0000", "PCTRs": "0.0000", "CTRs": "0.0000", "PCTOs": "0.0000", "CTOs": "0.0000" } }, "Mails": [{ "MailId": "A16415e5cb09bea04952bb0e09e25ca6802301", "Retry": "2", "Sents": "1", "Opens": "1", "Clicks": "2", "Accepteds": "1", "AcceptedsRate": "100.0000", "TAC": "0.0000", "PCTR": "0.0000", "CTR": "0.0000", "PCTO": "0.0000", "CTO": "0.0000" } ] }, "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Code": "NoData" } }
401
Unauthorized
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Code": "UserNotFoundOrWithoutPermissions" } }
500
Internal error
Example Value | Model
{ "Service": "UniqueMail", "Version": "1.0.13.0", "TransactionId": "INSTANCIA 03_20180222_6a7f91d0f6824457a58f89539721d8f7", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Code": "GeneralException" } }
/Archive/v1/{ClientName}/GetByRange
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
PageNumber
Número de página a la vista.
integer($int64) - (query)
PageSize
Cantidad de registros a mostrar.
integer($int64) - (query)
StartDate
Fecha inicial del listado de envíos.
string - (query)
EndDate
Fecha final del listado de envíos.
string - (query)
Order
Indica el orden del listado: Por fecha de envío (0 ascendente, 1 descendente).
integer($int32) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "PageDetails": { "TotalRecords": "408", "CurrentPage": "1", "TotalPages": "204" }, "Archives": { "Archive": [{ "From": "remitente@mail.com", "Serial": "25", "MailId": "3099", "Type": "0", "IdResp": "111", "MailUTCDate": "2016-12-15T13:34:14.973", "ArchiveDate": "2017-01-05T21:40:18.700", "Subject": "Asunto del envio", "URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8" } ] } }, "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Message": { "Code": "NoData" } } }
401
Unauthorized
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Message": { "Code": "UserNotFoundOrWithoutPermissions" } } }
500
Internal error
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
/Archive/v1/{ClientName}/GetByMailId
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
MailId*
Identificador del envío.
integer($int64) - (query)
Order
Cantidad de registros a mostrar.
integer($int32) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "Archive": [{ "From": "remitente@mail.com", "Serial": "25", "MailId": "3099", "Type": "0", "IdResp": "111", "MailUTCDate": "2016-12-15T13:34:14.973", "ArchiveDate": "2017-01-05T21:40:18.700", "Subject": "Asunto del envio", "URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8" } ] }, "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Message": { "Code": "NoData" } } }
401
Unauthorized
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
500
Internal error
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
/Archive/v1/{ClientName}/GetByEmail
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
Email*
Dirección de correo electrónico del destinatario.
integer($int64) - (query)
Order
Indica el orden del listado: Por fecha de envío (0 ascendente, 1 descendente).
integer($int32) - (query)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "Archive": [{ "From": "remitente@mail.com", "Serial": "25", "MailId": "3099", "Type": "0", "IdResp": "111", "MailUTCDate": "2016-12-15T13:34:14.973", "ArchiveDate": "2017-01-05T21:40:18.700", "Subject": "Asunto del envio", "URL": "https://ss-scl01.masterosr.com/out/v1/AQ02B02/170102/CLIENTE/19/2016-12-15T10/CLIENTE.0.3099.25@sender19.masterbase.com.eml/e5897589e9e14ee9b53a10e7bad963a8" } ] }, "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_01_20171102_e5897589e9e14ee9b53a10e7bad963a8", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "200", "Value": "OK" }, "Error": { "Message": { "Code": "NoData" } } }
401
Unauthorized
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Message": { "Code": "UserNotFoundOrWithoutPermissions" } } }
500
Internal error
Example Value | Model
{ "Service": "Archive", "Version": "1.0.2.0", "TransactionId": "Archive_04_20171019_cd26038250174628b7ba8274930b12d6", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
/Config/v1/{ClientName}/Fields/{ListId}
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
ListId*
Identificador de la base de contactos.
integer($int32) - (path)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "Field": [{ "Id": "84", "Name": "Email", "Display": "Email", "IntTtpe": "Str", "Required": "1", "MinLength": "1", "MaxLength": "150", "ReadOnly": 0, "PersonalizationString": "#!Email!#" } ] }, "Service": "Config", "Version": "1.0.3.0", "TransactionId": "CONFIG_04_20180223_9c7f1617f4d6408e8bba266d82f102f8", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "Config", "Version": "1.0.3.0", "TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Message": { "Code": "WarningException" } } }
401
Unauthorized
Example Value | Model
{ "Service": "Config", "Version": "1.0.3.0", "TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Message": { "Code": "CredentialsNotFound" } } }
500
Internal error
Example Value | Model
{ "Service": "Config", "Version": "1.0.3.0", "TransactionId": "CONFIG_04_20180223_839ad16e729b4c8fa5c11d3ac16abf72", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
/Content/v1/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
ListId*
Identificador de la base de contactos.
integer($int32) - (path)
(*) Parámetro obligatorio
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": { "Summary": { "CurrentPage": 1, "TotalPages": 1, "TotalRecords": 1, "Contents": [{ "Id": "84", "Type": "Anuncio Inmobiliario", "Name": "Inmobiliaria Saenz", "CreationDate": "2017-03-21T14:17:11.287", "Creator": "example@exmple.com", "ModificationDate": "2017-03-21T14:17:11.287", "Modificator": "example@exmple.com", "EnableDate": "2017-03-21T14:17:11.287", "ExpirationDate": "2017-03-21T14:17:11.287", "Status": "2" } ] } }, "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_56078b29566c42d0a1c90a30074558fd", "Status": { "Code": "200", "Value": "OK" } }
400
No Data
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Message": { "Code": "WarningException" } } }
401
Unauthorized
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Message": { "Code": "CredentialsNotFound" } } }
500
Internal error
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }
/Content/v1/{ClientName}
Parameters endpoints
Name
Description
Type
ClientName *
Nombre de la cuenta.
string($string) - (path)
ListId *
Identificador de la lista de contactos.
integer($int32) - (path)
Body *
Datos del contacto a modificar.
(body)
Example Value | Model
{ "Id": "159", "EnableDate": "2018-07-14T00:00:00", "ExpirationDate": "2018-07-30T03:00:00", "Status": "1" }
Responses
Code
200
Description
Succesfull response
Example Value | Model
{ "Data": "Updated", "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_56078b29566c42d0a1c90a30074558fd", "Status": { "Code": "200", "Value": "OK" } }
400
Description
No Data
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "400", "Value": "BadRequest" }, "Error": { "Message": { "Code": "WarningException" } } }
401
Description
Unauthorized
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "401", "Value": "Unauthoraized" }, "Error": { "Message": { "Code": "CredentialsNotFound" } } }
500
Description
Internal error
Example Value | Model
{ "Service": "Content", "Version": "1.0.1.0", "TransactionId": "CONTENT_20180713_0cf3566d77884022b1bc63298e312c92", "Status": { "Code": "500", "Value": "InternalServerError" }, "Error": { "Message": { "Code": "ErrorException" } } }