Create Bulk Smart Links API (Beta)

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

This API is used to create bulk smart links.

📘
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



[
{
  "longUrl": "https://touchstone1.webexcampaign.io/nextgen3",
  "domain": "ciscowebexcampaign6.com",
  "linkassetid":"4f5081f6def94c7386885d7408ffffa8",
  "redirectParam": "redirect",
  "encAlgo": "AES",
  "encPassKey": "testingtest@1234",
  "expiresOn": "2023-10-08T07:44:51.000Z",
  "expiryUrl": "https://touchstone1.webexcampaign.io/expired",
  "urlContext": {
    "msisdn": "123456789"
  },
  "referenceId": "6391b6da5481373783e33952"
},

{
  "longUrl": "https://touchstone1.webexcampaign.io/nextgen4",
  "domain": "ciscowebexcampaign6.com",
  "linkassetid":"4f5081f6def94c7386885d7408ffffb8",
  "redirectParam": "redirect",
  "encAlgo": "AES",
  "encPassKey": "testingtest@1234",
  "expiresOn": "2023-10-08T07:44:51.000Z",
  "expiryUrl": "https://touchstone1.webexcampaign.io/expired",
  "urlContext": {
    "msisdn": "123456789"
  },
  "referenceId": "6391b6da5481373783e33952"
},

{
  "longUrl": "https://touchstone1.webexcampaign.io/nextgen5",
  "domain": "ciscowebexcampaign6.com",
  "linkassetid":"4f5081f6def94c7386885d7408ffffc8",
  "redirectParam": "redirect",
  "encAlgo": "AES",
  "encPassKey": "testingtest@1234",
  "expiresOn": "2023-10-08T07:44:51.000Z",
  "expiryUrl": "https://touchstone1.webexcampaign.io/expired",
  "urlContext": {
    "msisdn": "123456789"
  },
  "referenceId": "6391b6da5481373783e33952"
}

]

Response Example

[
    {
        "code": "1001",
        "message": "SmartLinks Details Added Successfully.",
        "id": "93clT79V",
        "smartLink": "https://ciscowebexcampaign6.com/93clT79V"
    },
    {
        "code": "1001",
        "message": "SmartLinks Details Added Successfully.",
        "id": "2WTKJKgk",
        "smartLink": "https://ciscowebexcampaign6.com/2WTKJKgk"
    },
    {
        "code": "1001",
        "message": "SmartLinks Details Added Successfully.",
        "id": "UH4K35No",
        "smartLink": "https://ciscowebexcampaign6.com/UH4K35No"
    }
]

Response Parameters

This API will return the following response parameters:

Parameters	Description
code	Returns the success response code
message	Returns the confirmation message
id	Returns the smart link id.
smartlink	Returns 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.