Skip to main content

Get Links

This method returns all links contained in a particular Transactional Messaging Template.

This is a GET method.

REST URL

https://atmp-pub-api-www3.actito.com/transactional-api-ws/transactionalMessages/{template ID}/links
Input parameters
Required parameters
DescriptionOutput parametersDescription
tokenThe connection tokenreturnThe following link information:
  • id: The ID assigned to the link by the system when the link is created.
  • name: The name you defined for the link in the request.
  • order: The link order assigned to the link by the system when the link is created.
  • type: The type of link you defined for the link in the request.
  • url: The URL of the standard link you defined in the request.
Path Parameters 
template idThe ID of the Template

REST Example

Input

Method Type

GET

URL

https://atmp-pub-api-www3.actito.com/transactional-api-ws/transactionalMessages/31938/links

Header

Content-type: application/json
Authorization: Basic {Base64 encoded token}

Output

Status: 200

Body

[
{
"id": 671824,
"name": "linktest",
"order": 4,
"type": "STANDARD",
"url": "http://test.jsp"
},
{
"id": 670703,
"name": "linktest",
"order": 2,
"type": "STANDARD",
"url": "http://test.jsp"
},
{
"id": 670704,
"name": "linktest",
"order": 3,
"type": "STANDARD",
"url": "http://test.jsp"
}
]

Error Descriptions

Error Output Format Example

{
"id": "7d7d0654-5001-43ca-9b57-b89297a4f85b",
"status": 400,
"message": "error message"
}

Error Messages

The list below shows the possible error messages for the Transactional Messaging with Attachments API:

  • An internal error has occurred. Please contact the Support Team if the error persists.
  • The requested resource cannot be found {0}.
  • The credentials you entered are incorrect.
  • The Authorization header is missing.
  • The Authorization header is incorrectly encoded.
  • Basic authentication information is missing.
  • The JSON object body is either invalid or missing.
  • The following fields are missing or invalid.
  • You do not have the following user rights for the MESSAGE feature: {0}.
  • The field ''{0}'' is required.
  • You must include either the 'apiKey' field or the 'partnerKey' field.
  • The field ''{0}'' must be numeric.
  • The length of field ''{0}'' is greater than {1}.
  • Your sender is not validated for this type of message.
  • No sender found with this address {0} for this type of message.
  • Parameter ''{0}'' too long (max {1,number,#}).
  • Invalid parameter: ''{0}''.
  • The field ''{0}'' contains an invalid email value.
  • The body of an email message must begin with [EMV TEXTPART] OR [EMV HTMLPART].
  • The Transactional Message {0} cannot be deleted because it has already been sent.
  • The encoding is incorrect. Choose an encoding from this list: iso-8859-15, UTF-8, windows-1251, Big5, GB2312, EUC-KR, Shift_JIS, iso-8859-2, iso-8859-3, iso-8859-7.
  • Page {0} is invalid.
  • Your JSON has an invalid parameter.