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 HeaderDescription
content-Typeapplication/json
AuthorizationAccess 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:

ParameterTypeMandatoryDescription
longUrlStringYesReturns the long URL.
domainsStringYesReturns the domain name in which the smart link was created.
deviceRoutingStringYesReturns the OS specific URLs.
androidUrl: Returns the Android specific URL.
"iosUrl: Returns the iOS specific URL.
* "windowsUrl Returns the Windows specific URL.
redirectParamStringNoReturns the redirect parameter. The default value is redirect.
encAlgoStringYesReturns the encryption algorithm.
encPassKeyStringYesReturns the encryption passkey.
expiresOnStringYesReturns the date till which the link is valid.
expiryUrlStringYesReturns the redirect URL on link expiry.
urlContextStringYesReturns the context parameters that are used for personalization.
referenceIdStringYesReturns 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 CodeCode within API ResponseDescription
400NABad request
401NAInvalid token or Access token expired
404NANo Entity exists with the given Id.
405NAMethod not supported
500NAInternal server error.
Language