Get Smart Link Asset API (Beta)

📘
This API is currently available only for clients hosted in the AWS-USA data centre.

This API is used to get the details of a link asset by id.

📘
Based on the domain that is assigned, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request Header	Description
content-Type	application/json
Authorization	Access token in Bearer format Example: Bearer $(key)

Request Example



https://smartlink-dev.qa.imicampaign.io/sls/links/assets/c28334308cd04a239eecb85803dd2d2b

Response Example

{
    "longUrl": "https://touchstone1.webexcampaign.io/nextgen8",
    "domain": "ciscowebexcampaign6.com",
    "deviceRouting": {
        "androidUrl": null,
        "iosUrl": null,
        "windowsUrl": null
    },
    "urlContext": {
        "msisdn": "123456789"
    },
    "encAlgo": "AES",
    "encPassKey": "testingtest@1234",
    "expiresOn": "2023-10-08T07:44:51Z",
    "expiryUrl": "https://touchstone1.webexcampaign.io/expired",
    "srcProduct": "CMPN",
    "linkAssetId": "c28334308cd04a239eecb85803dd2d2b",
    "redirectParam": "redirect",
    "referenceId": "6391b6da5481373783e33952",
    "customContextPath": null
}

Response Parameters

This API will return the following response parameters:

Parameter	Type	Mandatory	Description
longUrl	String	Yes	Returns the long URL.
domains	String	Yes	Returns the domain name in which the smart link was created.
deviceRouting	String	Yes	Returns the OS specific URLs. androidUrl: Returns the Android specific URL. "iosUrl: Returns the iOS specific URL. * "windowsUrl Returns the Windows specific URL.
redirectParam	String	No	Returns the redirect parameter. The default value is redirect.
encAlgo	String	Yes	Returns the encryption algorithm.
encPassKey	String	Yes	Returns the encryption passkey.
expiresOn	String	Yes	Returns the date till which the link is valid.
expiryUrl	String	Yes	Returns the redirect URL on link expiry.
urlContext	String	Yes	Returns the context parameters that are used for personalization.
referenceId	String	Yes	Returns the referenceid of the smart link.

Failure Response Codes

The API will return a code within the response as per the following table in case of failure scenarios.

HTTP Status Code	Code within API Response	Description
400	NA	Bad request
401	NA	Invalid token or Access token expired
404	NA	No Entity exists with the given Id.
405	NA	Method not supported
500	NA	Internal server error.