Description
This method call will return the meta data for all welcome messages that are created within your account. If you want to retrieve the information of just a single welcome message, then be sure to include the welcome message ID as the <mess_id> element in the POSTed input.
Arguments
| Field | Description | Field Type | Required | Example |
|---|---|---|---|---|
| mess_id | The message ID number of the welcome message to retrieve | number | No | 1023491 |
| message_data | A boolean flag to indicate whether to include the welcome message body content in the response.
|
boolean | No | 1 |
Response
| Field | Description | Example |
|---|---|---|
| messages | This element is the main wrapper for all welcome messages included in the response. | |
| item | This element is the wrapper for each welcome message. | |
| subject | The subject line from the welcome message | Welcome to Buffalo Barn! |
| mess_id | The welcome message's message ID | 1027940 |
| from_description | The friendly from name used in the welcome message | Buffalo Barn |
| from_email | The actual "from" email address that appears in the message header | noreply@buffalobarn.com |
| reply_email | The "reply-to" emal address that appears in the message header | email@buffalobarn.com |
| trigger_value | The value of the welcome message trigger field that initiates the sending of this welcome message. | |
| enabled | Indicates whether this welcome message is curently enabled or disabled.
|
1 |
| delay_send | Indicates whether this welcome message is set to send 24 hours after the subscription record is posted in the database.
|
0 |
| is_default | Indicates whether this welcome message is set as the account default. Only one default welcome message is allowed per account. The default message is sent when the incoming subscriber registration data does not match any values assigned to the Welcome Message Trigger Field.
|
|
| message_notes | Optional information from the "Message Notes" text field | Signups from web site |
| bill_codes | Optional information from the "Bill Codes" text field | 0f7AC487 |
| footer | The name of the message footer (from the footer template library) used for this welcome message | Custom Footer |
| link_append | Optional query string parameters and values appended to all tracked links | language=english&souce=email |
| last_modified | The date and time this welcome message was last modified in YYYY-MM-DD HH24:MI:SS format | 2012-05-30 17:31:12 |
| message_tags | This element is the wrapper for all message tags that this welcome message has been tagged with. | |
| item | This element is the outer wrapper for each <tag> element | |
| tag | This element is the wrapper for all meta data of an individual message tag | |
| id | The tag's system ID number | 1272 |
| name | The tag's name defined within the account | Language |
| value | The tag value assigned to this specific welcome message | English |
| message_data | This element is the wrapper for the content of the three different content versions of the welcome message. This element will only be included in the response when <message_data>1</message_date> is included as a POSTed XML input parameter. | |
| html | The HTML content of the welcome message. It will be wrapped entirely within a CDATA tag | |
| plain | The plain text content of the welcome message. It will be wrapped entirely within a CDATA tag | |
| mobile_view | The Mobile View Online content of the welcome message. If none has been created for this welcome email, then this element will be empty | |
| binding | This parameter is used to return a binding to be used for a welcome message. Typically a well-known scientist name is used to name a binding | echo |
Response Codes
| Response Code | Response Text | Description |
|---|---|---|
| 669 | Displaying all requested Welcome Messages | Successful operation; welcome messages are successfully returned |
| 670 | Message ID passed is not a Welcome Message | The Message ID passed is not for a welcome message. It could either be a non-existent message ID or it could be an ID for a different type of message (e.g. promotional message, transactional message, etc.) |
| 671 | Account does not have any Welcome Messages | No welcome messages have been created yet for this account. |
Example Post
<methodCall>
<methodName>message.getWelcomeMessages</methodName>
<message_data>1</message_data>
</methodCall>
Example Response
<methodResponse>
<item>
<methodName><![CDATA[message.getWelcomeMessages]]></methodName>
<responseCode><![CDATA[669]]></responseCode>
<responseText><![CDATA[Displaying all requested Welcome Messages]]></responseText>
<responseData>
<messages>
<item>
<subject><![CDATA[Welcome To Buffalo Barn!]]></subject>
<message_id><![CDATA[1027940]]></message_id>
<from_description><![CDATA[Buffalo Barn]]></from_description>
<from_email><![CDATA[noreply@buffalobarn.com]]></from_email>
<reply_email><![CDATA[email@buffalobarn.com]]></reply_email>
<trigger_value><![CDATA[Trigger1]]></trigger_value>
<enabled><![CDATA[1]]></enabled>
<delay_send><![CDATA[0]]></delay_send>
<message_notes><![CDATA[Signups from U.S. Website]]></message_notes>
<bill_codes><![CDATA[0F7AC487]]></bill_codes>
<footer><![CDATA[Standard Footer]]></footer>
<link_append><![CDATA[language=english]]></link_append>
<last_modified><![CDATA[2012-05-30 17:31:12]]></last_modified>
<message_tags>
<item>
<tag>
<id><![CDATA[1272]]></id>
<name><![CDATA[Language]]></name>
<value<![CDATA[English]]></value>
</tag>
</item>
<item>
<tag>
<id><![CDATA[1283]]></id>
<name><![CDATA[Region]]></name>
<value<![CDATA[East Coast]]></value>
</tag>
</item>
</message_tags>
<message_data>
<html>
<![CDATA[
<html>
<head> ... </head>
<body>
... HTML content of the welcome message ...
</body>
</html>
]]>
</html>
<plain>
<![CDATA[
... Plain text content of the welcome message ...
]]>
</plain>
<mobile_view>
<![CDATA[
<html>
<head> ... </head>
<body>
... Mobile View content of the welcome message ...
</body>
</html>
]]>
</mobile_view>
</message_data>
</item>
</messages>
</responseData>
<responseNum>1</responseNum>
</item>
</methodResponse>
Example Error
<methodResponse>
<item>
<methodName><![CDATA[message.getWelcomeMessages]]></methodName>
<responseCode><![CDATA[670]]></responseCode>
<responseText><![Message ID passed is not a Welcome Message]]></responseText>
<responseData>
</responseData>
<responseNum>1</responseNum>
</item>
</methodResponse>