• No results found

SmartFocus Cloud Service APIs

N/A
N/A
Protected

Academic year: 2021

Share "SmartFocus Cloud Service APIs"

Copied!
109
0
0

Loading.... (view fulltext now)

Full text

(1)

Document name

Transactional Messaging Templates SOAP API Guide

Service

Transactional Messaging Service for Managing Templates

Protocol

SOAP over HTTP

Version

11.8

(2)

Table of Contents

Table of Contents 2

Introduction 5

About This Document 5

About SmartFocus APIs 5

Feedback 5

Support Options 5

Training Options 5

SmartFocus's Products and Services 5

Disclaimer 5

Introducing SmartFocus APIs 6

Module Overview 6

Getting started with integration 7

Prerequisites 7

Quick Start 7

Integration Using APIs 7

URL Encoding Considerations (for HTTP GET methods only) 8

Security 8

Overview of the Transactional Messaging Templates & Dynamic Content API 9

Transactional Messaging Templates and Dynamic Content API Use Cases 11

Connection 13

Recommended Token Usage 13

openApiConnection 14 closeApiConnection 16 Template Management 17 createTemplate 17 SOAP Example 18 createTemplateByObj 20 deleteTemplate 22 updateTemplate 23 updateTemplateByObj 25 cloneTemplate 27 getTemplate 28 getLastTemplates 30 getTemplatesByField 32 getTemplatesByPeriod 34 getTemplateSummaryList 36 getTemplatePreview 39 getTemplatePreviewByObj 41 getTemplatePreviewWithLinksByObj 44

(3)

createAndAddStandardTemplateUrl 47 createAndAddPersonalizedTemplateUrl 48 updateTemplateUrlByField 49 deleteTemplateUrl 51 trackAllTemplateLinks 52 untrackAllTemplateLinks 53 trackTemplateLinkByPosition 54 untrackTemplateLinkByOrder 56 getAllTemplateTrackableLinks 57 getAllTemplateTrackedLinks 58 getAllUnusedTemplateTrackedLinks 59 getNotifDefaultSender 60 getNotifNotValidatedSenders 61 getNotifValidatedAltSenders 62 addBanner 63 testTemplateByGroup 64 testTemplateByGroupByObj 66 testTemplateByMember 68 testTemplateByMemberByObj 70

Dynamic Content Management 72

createBanner 72 SOAP Example 72 createBannerByObj 74 updateBanner 76 updateBannerByObj 78 deleteBanner 80 cloneBanner 81 getBanner 82 getLastBanners 84 getBannersByField 86 getBannersByPeriod 88 getBannerPreview 90 getBannerPreviewByObj 91 createAndAddStandardBannerUrl 93 createAndAddPersonalizedBannerUrl 95 deleteBannerUrl 97 trackAllBannerLinks 98

(4)

updateBannerUrlByField 102 getBannerUrlByOrder 104 getAllBannerTrackableLinks 106 getAllBannerTrackedLinks 107 getAllUnusedBannerTrackedLinks 108 Reference 109

(5)

Introduction

About This Document

This document is a reference document for using SmartFocus APIs. It does not explain the purpose or functions of SmartFocus features. For information on these features, please consult theSmartFocus Online Helpor theSmartFocus User Guide. This document is intended for developers and project managers.

About SmartFocus APIs

An Application Programming Interface (API) is a source code interface that a computer system or program library provides in order to support requests for services made from another computer program.

The goal of SmartFocus APIs is to offer customers the ability to pilot a complete campaign from their own system.

Feedback

The Transactional Messaging Templates SOAP API Guide is constantly being enhanced to provide you with more and more information on using SmartFocus API methods.

If you can't find the information you need or want to provide feedback, simply drop us a line at documentation@smartfocus.com.

We look forward to hearing from you!

Support Options

SmartFocus provides you with a dedicated Account Manager to accompany you throughout the execution of your projects in SmartFocus. Your Account Manager is the gateway to support, training, and professional services. Working with your Account Manager, you can rely on SmartFocus’s deliverability and technical support teams for complex troubleshooting and

optimization.

Training Options

SmartFocus provides fully comprehensive training ranging from basic product training through to advanced modules and both strategic and tactical marketing courses. The training courses are designed to help you increase productivity, develop new methods, and share best practices to optimize your email, mobile, and social marketing campaigns.

To get more information on training, please contact your Account Manager.

SmartFocus's Products and Services

For more information on SmartFocus's products and services, please seewww.smartfocus.com

Disclaimer

While the information contained in this publication is believed to be true and accurate, SmartFocus cannot accept any legal responsibility for any errors or omissions contained herein. All information is subject to change without notice.

None of the material in this publication may be reproduced or transmitted in whole or in part without the express written permission of SmartFocus.

(6)

Introducing SmartFocus APIs

Module Overview

The Transactional module is a way to access your Transactional Messaging Templates and Dynamic Content Blocks (often referred to as Notification Messaging or NMP templates and banners) through the API.

(7)

Getting started with integration

Prerequisites

To access SmartFocus’s APIs and take full advantage of this software’s ease of integration with other systems, you will need the following:

l An Internet connection

l A recent browser and operating system

l An active SmartFocus account with the API feature enabled

Quick Start

The process for interfacing your website, CRM, or any other internal system with the APIs is quite straightforward.

Step 1: Get your API key in SmartFocus

Note:You must have a dedicated API login. This login will NOT have access to SmartFocus. Contact your Account Manager to have a dedicated API login.

To connect through the API, the user must first obtain a manager key using the CCMD Web Application.

Calling the connect method (with the login, password, manager key) will provide a token, to be used in all subsequent calls. This token will expire in the following cases:

l When a close connection call is made.

l When the maximum number of calls per session, defined by the manager in SmartFocus, is reached. l When the session times out.

Step 2: Build your application

Integration Using APIs

The first step in getting started with web services is to configure the range of remote servers that will access this module. Webmasters and developers should be able to interface with this new API with any programming language that uses standard HTTP calls.

List of APIs that are available: l RESTful API

l SOAP API

SOAP API

The SOAP API consists in posting an XML file through HTTP POST. l API call summary:

SOAP

Submission URL

(8)

SOAP

Parameters & associated values

l All parameter names are case sensitive.

l When specific values are expected, it should be assumed that parameter values are case sensitive. l The order of parameters must be strictly followed.

l A parameter and its contents must appear on the same line without spaces and line breaks. In this guide, line breaks have sometimes been added for display reasons.

URL Encoding Considerations (for HTTP GET methods only)

Some characters cannot be part of a URL - for example, spaces are not allowed. Some characters have a special meaning in a URL—for example, the hash (#) character is used to locate a specific point within a page, and the equals (=) character is used to separate a name from a value. A query string may need to be converted to satisfy these constraints. This can be done using a schema known as URL encoding. In particular, encoding the query string uses the following rules:

l Letters (A-Z and a-z) and numbers (0-9) are not encoded.

l The period (.), comma (,) , tilde (~), and underscore (_) characters are not encoded. l A space is encoded as%20.

l The forward slash (/) is encoded as%2F.

l All other characters are encoded as%FFhex representation with any non-ASCII characters first encoded as UTF-8 (or other specified encoding).

l To encode as RFC 1738, use the+sign to replace spaces.

Security

As web services are accessible over the Internet and can be interfaced with any system, there is a risk of fraudulent access and usage of the system. To tighten security, SmartFocus APIs can be accessed using the HTTPS protocol. To use HTTPS, just replaceHTTPwithHTTPSin all the submission URLs.

(9)

Overview of the Transactional Messaging Templates & Dynamic Content API

The Transactional Messaging Templates & Dynamic Content API allows you to manage your Transactional Messages and Dynamic Content:

l Create, edit, and delete Messages

l Create, edit, and delete Dynamic Content Blocks

l Add, edit, track, and untrack Message and Dynamic Content Block links

For further information on how to create, edit, and manage Transactional Messaging creatives, please consult theSmartFocus User GuideorSmartFocus Online Help.

(10)

l Connection

Method Description

openApiConnection This method provides a session token when given valid credentials. closeApiConnection This method terminates the session token.

l Template Management

Method Description

Template Management This method creates a Transactional Messaging Template.

createTemplateByObj This method creates a Transactional Messaging Template by object. deleteTemplate This method deletes a Transactional Messaging Template.

updateTemplate This method updates a Transactional Messaging Template. updateTemplateByObj This method updates a Template by object.

cloneTemplate This method clones a Transactional Messaging Template.

getTemplate This method retrieves a Transactional Messaging Template.

getLastTemplates This method retrieves the most recently created Transactional Messaging Templates.

getTemplatesByField This method retrieves a list of Transactional Messaging Templates containing a given value in a specified field.

getTemplatesByPeriod This method retrieves a list of Transactional Messaging Templates created during a specified period.

getTemplateSummaryList This method retrieves a list of Templates and their details.

getTemplatePreview This method retrieves a preview of the HTML or text part of a Template without personalization.

getTemplatePreviewByObj This method retrieves a Template preview by object using personalization and dynamic content fields.

getTemplatePreviewWithLinksByObj This method retrieves a Template preview with displayed links using personalization and dynamic content fields.

createAndAddStandardTemplateUrl This method creates and adds a standard link to the Template. createAndAddPersonalizedTemplateUrlThis method creates and adds a personalized link to the Template. updateTemplateUrlByField This method updates a Template link by field.

deleteTemplateUrl This method deletes a Template link.

trackAllTemplateLinks This method activates link tracking for all links in a Template. untrackAllTemplateLinks This method deactivates tracking for all the links in a Template. trackTemplateLinkByPosition This method activates link tracking for a link in a specific position in a

Template.

untrackTemplateLinkByOrder This method deactivates link tracking for specific link by its order number. getAllTemplateTrackableLinks This method retrieves a list of all the trackable links in a Template. getAllTemplateTrackedLinks This method retrieves a list of all the tracked links in a Template. getAllUnusedTemplateTrackedLinks This method retrieves a list of all the unused tracked links in a Template. getNotifDefaultSender This method retrieves the Transactional Messaging default sender. getNotifNotValidatedSenders This method retrieves the Transactional Messaging non-validated senders. getNotifValidatedAltSenders This method retrieves the Transactional Messaging validated senders.

(11)

Method Description

testTemplateByGroup This method sends a test email to a group of members. testTemplateByGroupByObj This method sends a test email to a group of members. testTemplateByMember This method sends a test email to a member.

testTemplateByMemberByObj This method sends a test email to a member. l Dynamic Content Management

Method Description

Dynamic Content Management This method creates a Dynamic Content Block.

createBannerByObj This method creates a Dynamic Content Block by object.

updateBanner This method updates a Dynamic Content Block by field and value. updateBannerByObj This method updates a Dynamic Content Block by object.

deleteBanner This method deletes a Dynamic Content Block.

cloneBanner This method clones a Dynamic Content Block.

getBanner This method retrieves a Dynamic Content Block using its ID.

getLastBanners This method retrieves the most recently created Dynamic Content Blocks. getBannersByField This method retrieves a list of Dynamic Content Blocks that contain the same

given value in a specific field.

getBannersByPeriod This method retrieves a list of Dynamic Content Blocks from a given period. getBannerPreview This method displays a preview of a Dynamic Content Block.

getBannerPreviewByObj This method retrieves a preview of a Dynamic Content Block by object. createAndAddStandardBannerUrl This method creates and adds a standard link to the Dynamic Content Block. createAndAddPersonalizedBannerUrlThis method creates and adds a personalized link to the Dynamic Content

Block.

updateBannerUrlByField This method updates a Dynamic Content Block link by field. deleteBannerUrl This method deletes a Dynamic Content Block link.

trackAllBannerLinks This method activates tracking for all untracked Dynamic Content Block links and saves the Dynamic Content Block.

trackBannerLinkByPosition This method tracks the Dynamic Content Block link through its position in the Dynamic Content Block.

untrackAllBannerLinks This method untracks all the Dynamic Content Block links.

untrackBannerLinkByOrder This method untracks a link in the Dynamic Content Block by its order. getBannerUrlByOrder This method retrieves a Dynamic Content Block link by its order number. getAllBannerTrackableLinks This method retrieves a list of all the trackable links in a Dynamic Content

Block.

getAllBannerTrackedLinks This method retrieves a list of all the tracked links in a Dynamic Content Block. getAllUnusedBannerTrackedLinks This method retrieves a list of all the unused tracked links of the Dynamic

Content Block.

Transactional Messaging Templates and Dynamic Content API Use Cases

Create a Dynamic Content Block and Add it to a Template

(12)

1. Use the openApiConnection method to open the connection.

2. Use the createBannerByObj method to create the Dynamic Content Block.

3. Use the getTemplatesByPeriod method to retrieve a list of recently created Templates and find the ID of the Template to which you want to add the Dynamic Content Block.

4. Use the addBanner method to add the Dynamic Content Block to the Template. 5. Use the closeApiConnection method to close the connection.

Clone a Template and Update the New Template with a Different Dynamic Content Block

To add a different Dynamic Content Block to a Template:

1. Use the openApiConnection method to open the connection. 2. Use the getTemplatesByPeriod method to find the Template ID. 3. Use the cloneTemplate method to clone the Template.

4. Use the getBannersByPeriod method to retrieve a list of recently created Dynamic Content Blocks and find the new Dynamic Content Block that you want to add.

5. Use the updateTemplateByObj method to add the new Dynamic Content Block to the Template. 6. Use the closeApiConnection method to close the connection.

(13)

Connection

Prerequisite:To use SmartFocus APIs, you need to have the API manager login provided by SmartFocus and the associated password.

To connect through the API, you must first retrieve the manager key from SmartFocus. 1. Go toAccount Administrationand selectLogins.

2. Click theEditicon next to your API manager.

3. In theAPIsection of the popup window, copy the API key (also known as the manager key) and use it to open a connection to retrieve the token that will be used in your calls.

Calling the connect method (with the login, password, manager key) will provide a token, to be used in all subsequent calls. This token will expire in the following cases:

l When a close connection call is made.

l When the maximum number of calls per session, defined by the manager in SmartFocus, is reached. l When the session times out.

Recommended Token Usage

An open connection call generates a token that should be used until it expires. Once the token expires, an API call will generate a session exception. At this point, you should open a new connection to continue your API calls.

Example:An example workflow:

1. Open the connection to generate the token.

2. Use API method calls as needed. If a call fails due to a problem with the session: a. Send another open connection call to renew the token.

b. Resend the call that failed due to the session issue.

3. Send a close connection call once all API method calls for the session have been sent successfully.

Note:For time consuming calls (e.g., uploading a large file), you may need to use an open connection call to ensure that the token will remain valid for the duration of the call.

(14)

openApiConnection

This method provides a session token when given valid credentials.

Note:The token is valid for 60 minutes.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters Required parameters Description Output parameters Description

login The login provided for API access return The token to use in all other

API calls

pwd

The password

Note: API passwords expire after 365 days.

key The manager key copied from SmartFocus (see Connectionon page 13)

Error messages

You must fill in the apiName parameter to check rights of client on this API. You must fill in the login parameter to authentifiate on this API.

You must fill in the password parameter to authentifiate on this API. You must fill in the managerKey parameter to authentifiate on this API. Error while decoding managerKey.

Your login is not valid !! Your password is not valid !!

No manager retrieved for those login, password. No available connection for manager {0}.

{0} doesn't exist or is not activated on client account. {0} is not activated for the client.

This manager does not have authorized access to this API. Error while parsing validDate on managerKey.

Date not valid on managerKey!

(15)

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:openApiConnection> <login>br_test</login> <pwd>aptrokez</pwd> <key>CdX7CrlE_26blFNJOsgfdawh6LJ3y6pwg5PEOvA</key> </api:openApiConnection> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:openApiConnectionResponse xmlns:n-s2="http:/api.service.apitransactional.emailvision.com/"> <return>{token}</return> </ns2:openApiConnectionResponse> </soap:Body> </soap:Envelope>

(16)

closeApiConnection

This method terminates the session token.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameter Required parameters Description Output parameter Description

token The connection

token return

The connection is closed if the operation was successful, otherwise an error code appears.

Error messages

You must fill in the token parameter

No available connection for the specified token. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:closeApiConnection> <token>{token}</token> </api:closeApiConnection> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:closeApiConnectionResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>connection closed</return> </ns2:closeApiConnectionResponse> </soap:Body> </soap:Envelope>

(17)

Template Management

createTemplate

This method creates a Transactional Messaging Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters Required parameters Description Output parameters Description

token The connection token return The ID of theTemplate

name The name of the Template

description The description of the Template subject The subject of the Template

from The From name. For SMS messages, the From name cannot

exceed 11 characters. fromEmail The From email address

to The To name

encoding The encoding used (e.g. UTF-8)

body The body of the Template (must be between the tags<![CDATA[ and]]>)

replyTo The Reply To name

replyToEmail The Reply To email address

type

The type of Template: l TRANSACTIONAL l SOCIALNETWORK

Error messages

You must fill in the token parameter You must fill in the name parameter. You must fill in the description parameter. You must fill in the subject parameter. You must fill in the from parameter. You must fill in the fromEmail parameter. You must fill in the to parameter.

(18)

This sender is not configured for your account. Template type not supported.

An error occured on the server

SOAP Example

Input

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:createTemplate> <token>{token}</token> <name>first test</name>

<description>Special rose promotion template</description> <subject>Special Rose Bouquet</subject>

<from>John Blum, Flower power Shop</from> <fromEmail>johnblum@smartfocus.com</fromEmail> <to>Dear Customer</to> <encoding>Shift-JIS</encoding> <body> <![CDATA[[EMV HTMLPART] <html> <body/>

<table width="625" border="0" align="center" cellpadding="0" cellspacing="0"> <tr>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="86" height="20"> </td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="453" height-t="20">

</td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="86" height-t="20"> </td> </tr> <tr> <td bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/logo.gif" width="453" height-t="44"> </td> <td bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td colspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3"> <img src="http://

emailvision.com/web/imgv5/framebluetop.gif" width="453" height="14"> </td>

<td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr>

<tr>

<td bgcolor="#00A0DA">

<table width="453" border="0" cellspacing="0" cellpadding="0"> <tr>

(19)

<td width="433">

<font face="Arial" size="3" color="#FFFFFF"> <b>Hello,

<br>You have successfully subscribed to Emailvision magazine.</b> </font> </td> <td width="10">&nbsp;</td> </tr> </table> </body> </html>]]></body> <replyTo>John</replyTo> <replyToEmail>johnblum@smartfocus.com</replyToEmail> <type>SOCIALNETWORK</type> </api:createTemplate> </soapenv:Body> </soapenv:Envelope>

Output

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:createTemplateResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>196</return> </ns2:createTemplateResponse> </soap:Body> </soap:Envelope>

(20)

createTemplateByObj

This method creates a Transactional Messaging Template by object.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection tokenreturn The ID of the Template template The Template object

Error messages

You must fill in the token parameter You must fill in the name parameter. You must fill in the description parameter. You must fill in the subject parameter. You must fill in the from parameter. You must fill in the fromEmail parameter. You must fill in the to parameter.

You must fill in the encoding parameter. You must fill in the replyTo parameter. You must fill in the replyToEmail parameter. You must fill in the type parameter.

Error while retrieving the default sender on your account. This sender is not configured for your account.

Template type not supported. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:createTemplateByObj> <token>{token}</token> <template>

<name>Special Rose Bouquet</name>

<description>Order confirmation</description> <subject>Special Rose Bouquet</subject> <from>John Blum, Flower power Shop</from> <fromEmail>info@flowerpowershop.com</fromEmail> <to>Dear Customer</to>

<encoding>Shift-JIS</encoding> <body>

(21)

/DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address:[EMV DYN] EMAIL[EMV /DYN][EMV CONTENT]2[EMV /CONTENT]Let us know if you have any question.My Date Customer Service.[EMV HTMLPART]

<html> <head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>My Sample HTML</title>

</head> <body>

<img src="http://mypath/to/my/header.gif" width="600" height="100"/> <table width="600" border="0" cellspacing="0" cellpadding="0">

<tr> <td>

<font size="2" face="Arial">Dear [EMV DYN]FIRSTNAME[EMV /DYN] [EMV DYN] LASTNAME[EMV /DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address: [EMV DYN]EMAIL[EMV /DYN]

<font size="2" face="Arial">Let us know if you have any question.My Date Customer Service.</font>

</td> </tr>

</table>[EMV CONTENT]1[EMV /CONTENT]

<font size="2" face="Arial">Let us know if you have any question.My Date Cus-tomer Service.</body> </html>]]></body> <replyTo>John Blum</replyTo> <replyToEmail>john@flowerpowershop.com</replyToEmail> <type>TRANSACTIONAL</type> </template> </api:createTemplateByObj> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:createTemplateByObjResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>224</return> </ns2:createTemplateByObjResponse> </soap:Body> </soap:Envelope>

(22)

deleteTemplate

This method deletes a Transactional Messaging Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection token return trueif it was successful,falseif it was not

successful

id The ID of the

Template

Error messages

You must fill in the token parameter No template found !!

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:deleteTemplate> <token>{token}</token> <id>193</id> </api:deleteTemplate> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:deleteTemplateResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>true</return> </ns2:deleteTemplateResponse> </soap:Body> </soap:Envelope>

(23)

updateTemplate

This method updates a Transactional Messaging Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection token return trueif it was successful,falseif it was not

successful

id The ID of the Template

field

The field to update l name l description l subject l from l to l replyTo l replyToEmail l encoding value The value to set for the

field

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the field parameter. You must fill in the name parameter. You must fill in the encoding parameter. You must fill in the replyTo parameter. No template found !!

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/">

(24)

<value>api_creation_update</value> </api:updateTemplate> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateTemplateResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>true</return> </ns2:updateTemplateResponse> </soap:Body> </soap:Envelope>

(25)

updateTemplateByObj

This method updates a Template by object.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection

token return

trueif it was successful,falseif it was not successful

template The Template object

Error messages

You must fill in the token parameter No template found !!

Error while retrieving the default sender on your account. This sender is not configured for your account.

Template type not supported. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:updateTemplateByObj> <token>{token}</token> <template> <id>224</id>

<name>Special Rose Bouquet</name>

<description>Order confirmation</description> <subject>Special Rose Bouquet</subject> <from>John Blum, Flower power Shop</from> <fromEmail>info@flowerpowershop.com</fromEmail> <to>Dear Customer</to>

<encoding>Shift-JIS</encoding> <body>

<![CDATA[[EMV TEXTPART]Dear [EMV DYN]FIRSTNAME[EMV /DYN] [EMV DYN]LASTNAME[EMV /DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address:[EMV DYN] EMAIL[EMV /DYN][EMV CONTENT]2[EMV /CONTENT]Let us know if you have any question.My Date Customer Service.[EMV HTMLPART]

(26)

<img src="http://mypath/to/my/header.gif" width="600" height="100"/> <table width="600" border="0" cellspacing="0" cellpadding="0">

<tr> <td>

<font size="2" face="Arial">Dear [EMV DYN]FIRSTNAME[EMV /DYN] [EMV DYN] LASTNAME[EMV /DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address: [EMV DYN]EMAIL[EMV /DYN]

<font size="2" face="Arial">Let us know if you have any question.My Date Customer Service.</font>

</td> </tr>

</table>[EMV CONTENT]1[EMV /CONTENT]

<font size="2" face="Arial">Let us know if you have any question.My Date Cus-tomer Service.</body> </html>]]></body> <replyTo>John Blum</replyTo> <replyToEmail>john@flowerpowershop.com</replyToEmail> <type>SOCIALNETWORK</type> </template> </api:updateTemplateByObj> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateTemplateByObjResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>true</return> </ns2:updateTemplateByObjResponse> </soap:Body> </soap:Envelope>

(27)

cloneTemplate

This method clones a Transactional Messaging Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return The ID of the Template

id The ID of the Template

newName The new name for the cloned Template

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the name parameter. No template found !!

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:cloneTemplate> <token>{token}</token> <id>196</id>

<newName>copy Special Rose Bouquet</newName> </api:cloneTemplate> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:cloneTemplateResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>201</return> </ns2:cloneTemplateResponse> </soap:Body> </soap:Envelope>

(28)

getTemplate

This method retrieves a Transactional Messaging Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return The Template object

id The ID of the Template

Error messages

You must fill in the token parameter You must fill in the id parameter. No template found !!

Error while retrieving the default sender on your account. Error while retrieving the defined sender for this template. Template type not supported.

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getTemplate> <token>{token}</token> <id>201</id> </api:getTemplate> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplateResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return> <body>

<![CDATA[[EMV TEXTPART]Dear [EMV DYN]FIRSTNAME[EMV /DYN] [EMV DYN]LASTNAME[EMV /DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address:[EMV DYN] EMAIL[EMV /DYN][EMV CONTENT]2[EMV /CONTENT]Let us know if you have any question.My Date Customer Service.[EMV HTMLPART]

<html> <head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>My Sample HTML</title>

(29)

</head> <body>

<img src="http://mypath/to/my/header.gif" width="600" height="100"/> <table width="600" border="0" cellspacing="0" cellpadding="0">

<tr> <td>

<font size="2" face="Arial">Dear [EMV DYN]FIRSTNAME[EMV /DYN] [EMV DYN] LASTNAME[EMV /DYN],Thank you for subscribing to MyDate.You are subscribed with the Email address: [EMV DYN]EMAIL[EMV /DYN]

<font size="2" face="Arial">Let us know if you have any question.My Date Customer Service.</font>

</td> </tr>

</table>[EMV CONTENT]1[EMV /CONTENT]

<font size="2" face="Arial">Let us know if you have any question.My Date Cus-tomer Service.</body>

</html>]]></body>

<description>Order confirmation</description> <encoding>Shift-JIS</encoding>

<encrypt>EdX7CqkmjTt88SA93241132MKJP2vTULT53124zFK7L-kvde602W8WrKmk</encrypt> <from>John Blum, Flower power Shop</from>

<fromEmail>email@blandine.ccemails.com</fromEmail> <id>201</id>

<name>copy Special Rose Bouquet</name> <random>35B9838324320C004035B</random> <replyTo>John Blum</replyTo>

<replyToEmail>john@flowerpowershop.com</replyToEmail> <sent>false</sent>

<subject>A more fancy subject</subject> <to>Dear Customer</to> <type>TRANSACTIONAL</type> </return> </ns2:getTemplateResponse> </soap:Body> </soap:Envelope>

(30)

getLastTemplates

This method retrieves the most recently created Transactional Messaging Templates.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return The list of Template IDs

type

The type of Template: l TRANSACTIONAL l SOCIALNETWORK

limit The maximum number of Templates to retrieve

Error messages

You must fill in the token parameter You must fill in the type parameter. You must fill in the limit parameter. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getLastTemplates> <token>{token}</token> <type>TRANSACTIONAL</type> <limit>10</limit> </api:getLastTemplates> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getLastTemplatesResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>201</return> <return>200</return> <return>197</return> <return>196</return> <return>194</return> <return>103</return> <return>66</return> <return>30</return> <return>29</return>

(31)

</ns2:getLastTemplatesResponse> </soap:Body>

(32)

getTemplatesByField

This method retrieves a list of Transactional Messaging Templates containing a given value in a specified field.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return The list of Template IDs

type

The type of Template: l TRANSACTIONAL l SOCIALNETWORK

field

The field containing the criteria (value): l name l description l subject l from l to l replyTo l replyToEmail l encoding

value The value to set for the field

limit The size of the list (between 1 and 1000)

Error messages

You must fill in the token parameter You must fill in the type parameter. You must fill in the field parameter. You must fill in the limit parameter. You must fill in the name parameter. You must fill in the encoding parameter. You must fill in the replyToEmail parameter. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getTemplatesByField> <token>{token}</token> <type>TRANSACTIONAL</type> <field>name</field>

(33)

<value>Rose</value> <limit>10</limit> </api:getTemplatesByField> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplatesByFieldResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>201</return> <return>196</return> </ns2:getTemplatesByFieldResponse> </soap:Body> </soap:Envelope>

(34)

getTemplatesByPeriod

This method retrieves a list of Transactional Messaging Templates created during a specified period.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection token return The list of TemplateIDs

type

The type of Template: l TRANSACTIONAL l SOCIALNETWORK

dateBegin The start date of the period to retrieve (yyyy-MM-dd HH:mm:ss)

dateEnd The end date of the period to retrieve (yyyy-MM-dd HH:mm:ss)

Error messages

You must fill in the token parameter You must fill in the type parameter. You must fill in the dateBegin parameter. You must fill in the dateEnd parameter.

dateBegin doesn't exist or is malformed (good format is : yyyy-MM-dd HH:mm:ss). dateEnd doesn't exist or is malformed (good format is : yyyy-MM-dd HH:mm:ss). An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getTemplatesByPeriod> <token>{token}</token> <type>TRANSACTIONAL</type> <dateBegin>2009-10-23 00:00:00</dateBegin> <dateEnd>2009-10-25 00:00:00</dateEnd> </api:getTemplatesByPeriod> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body>

(35)

<ns2:getTemplatesByPeriodResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>194</return> <return>200</return> <return>201</return> <return>197</return> <return>196</return> </ns2:getTemplatesByPeriodResponse> </soap:Body> </soap:Envelope>

(36)

getTemplateSummaryList

This method retrieves a list of Templates and their details.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameter Required parameters Description Output parameterDescription

token The connection token return The Templates

and their details

List Options Parameters

page The page to return

pageSize The number of elements to return per page (default: 1000)

Search Parameters

search The search envelope

id The ID of the Template

name The name of the Template

subject

The subject of the message.

Note: The subject cannot exceed 2000 characters.

from The From name. For SMS messages, the From name cannot exceed 11

characters.

to The To name

minCreationDate The start date of the creation date range.

maxCreationDate The end date of the creation date range.

minModifDate The start date of the modification date range.

maxModifDate The end date of the modification date range.

Sort Options Parameters

sortOptions The envelope containing the sortOption envelope(s)

sortOption The sortOption envelope that specifies which column should be used for

the sort and in which order the sort should be applied

column

The column that should be used for the sort l id l name l from l to l creationDate l modifDate

(37)

Input parameter Required parameters Description Output parameterDescription order

The order of the sort (i.e., ascending or descending): l ASC

l DESC

Note:The values must be in uppercase.

Error messages

You must fill in the token parameter An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getTemplateSummaryList> <token>token</token> <listOptions> <page>1</page> <pageSize>100</pageSize> <search> <minModifDate>2013-03-18 11:00:00</minModifDate> <maxModifDate>2013-03-18 18:00:00</maxModifDate> </search> <sortOptions> <sortOption> <column>modifDate</column> <order>ASC</order> </sortOption> </sortOptions> </listOptions> </api:getTemplateSummaryList> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplateSummaryListResponse xmlns:n-s2="http://api.service.apitransactional.emailvision.com/"> <return> <templateSummaryList> <templateSummary> <id>62</id> <name>Template 2</name>

(38)

<replyToEmail>john.smith@example.com</replyToEmail> <creationDate>2013-03-18 11:15:07</creationDate> <modifDate>2013-03-18 17:46:50</modifDate> </templateSummary> <templateSummary> <id>61</id> <name>Template 1</name> <fromEmail>jane.scott@example.com</fromEmail> <replyToEmail>jane.scott@example.com</replyToEmail> <creationDate>2013-03-18 11:12:30</creationDate> <modifDate>2013-03-18 11:12:58</modifDate> </templateSummary> </templateSummaryList> <pageSize>10</pageSize> <nbTotalItems>2</nbTotalItems> <page>1</page> <nextPage>false</nextPage> <previousPage>false</previousPage> </return> </ns2:getTemplateSummaryListResponse> </soap:Body> </soap:Envelope>

(39)

getTemplatePreview

This method retrieves a preview of the HTML or text part of a Template without personalization.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters Required parameters Description Output parameters Description

token The connection token return The Template preview for the specified part

(HTML or TEXT)

id The ID of the Template

part The part of the Template (HTML or TEXT)

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the part parameter. No template found !!

TEXT part doesn't exist or is malformed. HTML part doesn't exist or is malformed. Unable to retrieve the links of the template. Unable to retrieve xheaders.

The content doesn't have [EMV DYN] tags. The dyn tags are probably malformed.

The content doesn't have [EMV CONTENT] tags. Error while formatting the template for send request. Error while formatting the template.

Template type not supported. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/">

<soapenv:Header/> <soapenv:Body>

(40)

</soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplatePreviewResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/">

<return>Dear ,Thank you for subscribing to MyDate.You are subscribed with the Email address:Let us know if you have any question.My Date Customer Service.</return>

</ns2:getTemplatePreviewResponse> </soap:Body>

(41)

getTemplatePreviewByObj

This method retrieves a Template preview by object using personalization and dynamic content fields.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters Required parameters Description Output parameters Description

token The connection token return The Template preview with correctly

displayed links part The part of the Template to preview

(HTML or TEXT)

templatePerso The templatePerso object

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the part parameter. No template found !!

TEXT part doesn't exist or is malformed. HTML part doesn't exist or is malformed. Unable to retrieve the links of the template. Unable to retrieve xheaders.

The content doesn't have [EMV DYN] tags. The dyn tags are probably malformed.

The content doesn't have [EMV CONTENT] tags. Error while formatting the template for send request. Error while formatting the template.

Template type not supported. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/">

<soapenv:Header/> <soapenv:Body>

(42)

<contentItem> <label>1</label> <value>fdsjkhfdjkshds</value> <label>2</label> <value>aaaaaaaaaaaa</value> </contentItem> </contentItemList> <persoItemList> <persoItem> <label>email</label> <value>AAAAA</value> </persoItem> <persoItem> <label>firstname</label> <value>BBBBBBB</value> </persoItem> <persoItem> <label>lastname</label> <value>CCCCCCC</value> </persoItem> </persoItemList> <templateId>196</templateId> </templatePerso> </api:getTemplatePreviewByObj> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplatePreviewByObjResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return> <![CDATA[ <html> <head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>My Sample HTML</title>

</head> <body>

<img src="http://mypath/to/my/header.gif" width="600" height="100"/> <table width="600" border="0" cellspacing="0" cellpadding="0">

<tr> <td> <a href="http://wiki.emv2.com/index.php?title=CCMD_API&amp;ac-tion=edit">Edit</a> <a href="http://wiki.emv2.com/index.php?title=CCMD_ API&amp;action=copy">Copy</a> <a href-f="http://nmtritgr1.campaigncommander.com/H?a=CyoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3z4wjtS5kGaPC VJyU">Paste</a> <a href-f="http://nmtritgr1.campaigncommander.com/H?a=CyoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3z4wjtS5kGaPC UJyQ">Drag</a>

<font size="2" face="Arial">Dear BBBBBBB CCCCCCC,Thank you for subscribing to My Date.You are subscribed with the Email address: johnsmith@smartfocus.com

<font size="2" face="Arial">Let us know if you have any questions.My Date Customer Service.</font>

</td> </tr> </table>

<font size="2" face="Arial">Let us know if you have any questions.My Date Cus-tomer Service.

<table width="625" border="0" align="center" cellpadding="0" cellspacing="0"> <tr>

(43)

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="86" height-t="20">

</td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="453" height="20">

</td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="86" height="20"> </td> </tr> <tr> <td bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/yahoo/logo.gif" width-h="453" height="44"> </td> <td bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td colspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3"> <img src="http://emailvision.com/web/imgv5/blueframetop.gif" width="453" height="14"> </td> <td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td bgcolor="#00A0DA">

<table width="453" border="0" cellspacing="0" cellpadding="0"> <tr>

<td width="10">&nbsp;</td> <td width="433">

<font face="Arial" size="3" color="#FFFFFF"> <b>Hello,

<br>You have successfully subscribed to the Emailvison magazine.</b> </font> </td> <td width="10">&nbsp;</td> </tr> </table>ht-tp://nmtritgr1.campaigncommander.com/H?a=CCoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3zmQjtS5kGa PDALk,ex5GZWU9l2g</body> </html>]]></return> </ns2:getTemplatePreviewByObjResponse> </soap:Body> </soap:Envelope>

(44)

getTemplatePreviewWithLinksByObj

This method retrieves a Template preview with displayed links using personalization and dynamic content fields.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection token return The Templatepreview

part The part of the Template to preview (HTML or TEXT)

templatePerso The templatePerso object

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the part parameter. No template found !!

TEXT part doesn't exist or is malformed. HTML part doesn't exist or is malformed. Unable to retrieve the links of the template. Unable to retrieve xheaders.

The content doesn't have [EMV DYN] tags. The dyn tags are probably malformed.

The content doesn't have [EMV CONTENT] tags. Error while formatting the template for send request. Error while formatting the template.

Template type not supported. An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:getTemplatePreviewWithLinksByObj> <token>{token}</token> <part>HTML</part> <templatePerso> <contentItemList> <contentItem> <label>1</label>

(45)

<value>fdsjkhfdjkshds</value> <label>2</label> <value>aaaaaaaaaaaa</value> </contentItem> </contentItemList> <persoItemList> <persoItem> <label>email</label> <value>AAAAA</value> </persoItem> <persoItem> <label>firstname</label> <value>BBBBBBB</value> </persoItem> <persoItem> <label>lastname</label> <value>CCCCCCC</value> </persoItem> </persoItemList> <templateId>196</templateId> </templatePerso> </api:getTemplatePreviewWithLinksByObj> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:getTemplatePreviewWithLinksByObjResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return> <![CDATA[ <html> <head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>My Sample HTML</title>

</head> <body>

<img src="http://mypath/to/my/header.gif" width="600" height="100"/> <table width="600" border="0" cellspacing="0" cellpadding="0">

<tr> <td> <a href="http://wiki.emv2.com/index.php?title=CCMD_API&amp;ac-tion=edit">Edit</a> <a href="http://wiki.emv2.com/index.php?title=CCMD_ API&amp;action=copy">Copy</a> <a href-f="http://nmtritgr1.campaigncommander.com/H?a=CyoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3z4wjtS5kGaPC VJyU">Paste</a> <a href-f="http://nmtritgr1.campaigncommander.com/H?a=CyoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3z4wjtS5kGaPC UJyQ">Drag</a>

<font size="2" face="Arial">Dear BBBBBBB CCCCCCC,Thank you for subscribing to My Date.You are subscribed with the Email address: johnsmith@smartfocus.com

<font size="2" face="Arial">Let us know if you have any questions.My Date Customer Service.</font>

</td> </tr> </table>

(46)

Cus-height="20">

</td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="453" height="20">

</td>

<td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/spacer.gif" width="86" height="20"> </td> </tr> <tr> <td bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3">

<img src="http://emailvision.com/web/imgv5/yahoo/logo.gif" width-h="453" height="44"> </td> <td bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td colspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> <td bgcolor="#F3F3F3"> <img src="http://emailvision.com/web/imgv5/blueframetop.gif" width="453" height="14"> </td> <td rowspan="3" bgcolor="#F3F3F3">&nbsp;</td> </tr> <tr> <td bgcolor="#00A0DA">

<table width="453" border="0" cellspacing="0" cellpadding="0"> <tr>

<td width="10">&nbsp;</td> <td width="433">

<font face="Arial" size="3" color="#FFFFFF"> <b>Hello,

<br>You have successfully subscribed to the Emailvison magazine.</b> </font> </td> <td width="10">&nbsp;</td> </tr> </table>ht-tp://nmtritgr1.campaigncommander.com/H?a=CCoE9VbZcs4Q8SA9MKJP2z7nGHxKLJ3zmQjtS5kGa PDALk,ex5GZWU9l2g</body> </html>]]></return> </ns2:getTemplatePreviewWithLinksByObjResponse> </soap:Body> </soap:Envelope>

(47)

createAndAddStandardTemplateUrl

This method creates and adds a standard link to the Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return order- The order number of the URL templateId The ID of the Template

name The name of the URL

url The URL of the link

Error messages

You must fill in the token parameter You must fill in the bannerId parameter. You must fill in the name parameter. You must fill in the url parameter. No banner found !!

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:createAndAddStandardTemplateUrl> <token>{token}</token> <templateId>176</templateId> <name>LinkName</name> <url>www.smarfocus.com</url> </api:createAndAddStandardTemplateUrl> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:createAndAddStandardTemplateUrlResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>8</return> </ns2:createAndAddStandardTemplateUrlResponse>

(48)

createAndAddPersonalizedTemplateUrl

This method creates and adds a personalized link to the Template.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parametersDescription Output parameters Description

token The connection token return order- The order number of the URL templateId The ID of the Template

name The name of the URL

url The URL of the link

Error messages

You must fill in the token parameter You must fill in the bannerId parameter. You must fill in the name parameter. You must fill in the url parameter. No banner found !!

An error occured on the server

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:createAndAddPersonalizedTemplateUrl> <token>{token}</token> <templateId>176</templateId> <name>LinkName</name> <url>www.smarfocus.com</url> </api:createAndAddPersonalizedTemplateUrl> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:createAndAddPersonalizedTemplateUrlResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>8</return> </ns2:createAndAddPersonalizedTemplateUrlResponse> </soap:Body> </soap:Envelope>

(49)

updateTemplateUrlByField

This method updates a Template link by field.

WSDL location

https://{server}/apitransactional/services/TransactionalService?wsdl

Note:Ask your Account Manager for your server name.

Input parameters

Required parameters

Description Output

parameters Description

token The connection token return trueif it was successful,falseif it was not

successful

id The ID of the Template

order The order number of the URL

field

The field of the Template: l name

l description l contentType

value

The value of the field Requiredfor:

l thenamefield l thecontentTypefield

(0=TEXT, 1=HTML)

Optionalfor:

l thedescriptionfield

Error messages

You must fill in the token parameter You must fill in the id parameter. You must fill in the order parameter. You must fill in the field parameter. This link doesn't exist for the banner. You must fill in the name parameter. You must fill in the url parameter. You must fill in the parameters field. You must fill in the action field. Banner link type not supported. An error occured on the server

(50)

SOAP Example

In p u t

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api= "http://api.service.apitransactional.emailvision.com/"> <soapenv:Header/> <soapenv:Body> <api:updateTemplateUrlByField> <token>{token}</token> <id>165</id> <order>7</order> <field>url</field> <value>http://www.smarfocus.com</value> </api:updateTemplateUrlByField> </soapenv:Body> </soapenv:Envelope>

Ou tp u t

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:updateTemplateUrlByFieldResponse xmlns:ns2="http:// api.service.apitransactional.emailvision.com/"> <return>true</return> </ns2:updateTemplateUrlByFieldResponse> </soap:Body> </soap:Envelope>

References

Related documents

The paper is structured into the following sections: (1) “The geographies of enclosure ” introduces existing geographic scholarship on enclosure; (2) “Ground zero ” revisits

[r]

[r]

In this review, the research carried out using various ion-exchange resin-like adsorbents including modified clays, lignocellulosic biomasses, chitosan and its derivatives, microbial

While in Table 3 we present a pooled specification, to increase the chances for the added variables to exert a significant impact, in unreported regressions we repeat the

Kentucky Rule 1.15 (d) provides Ò A lawyer may deposit funds in an account for the limited purpose of minimizing bank charges.Ó I doubt if this provision was imple- mented with

university reform claims that strategic manage- ment has been strengthened in the universities, while the role of university per- sonnel has remained weak. Two major strategy

[r]