Данный метод API позволяет сокращать ваши ссылки, которые отправляются контактам.
Когда человек перейдет по ссылке, в контакт добавиться примечание о переходе на сайт.
Так же, человеку прикрепится пиксель, по которому в дальнейшем может произойти автоматическое объединение чатов.

Для каждого контакта генерируется отдельная ссылка.
То есть, если одну и ту же ссылку нужно отправить нескольким контактам, для каждого контакта нужно сгенерировать отдельную ссылку.

При этом, если вы хотите показать менеджеру, что ссылка была отправлена клиенту, например, создать об этом примечание, то менеджер должен видеть только исходную ссылку, не должен видеть или переходить по короткой, которая была отправлена клиенту.

Создание коротких ссылок

Метод

POST /api/v4/short_links

Описание

Метод позволяет генерировать короткие ссылки по одной или пакетно.

Ограничения

Метод доступен в соответствии с правами пользователя. На сущности, на которые нет прав – ссылки не будут сгенерированы.
Не более 250 ссылок за 1 запрос.

Заголовок запроса

Content-Type: application/json

Параметры запроса

Пример запроса

        
[
   {
      "url":"https://www.yandex.ru",
      "metadata":{
         "entity_type":"contacts",
         "entity_id":11070881
      }
   }
]
        
    

Заголовок типа данных при успешном результате

Content-Type: application/hal+json

Заголовок типа данных при ошибке

Content-Type: application/problem+json

HTTP коды ответа

Параметры ответа

Метод возвращает коллекцию сгенерированных ссылок, рассмотрим ниже свойства свойства ссылки.

Пример ответа

        
{
    "_links": {
        "self": {
            "href": "/api/v4/short_links"
        }
    },
    "_embedded": {
        "short_links": [
            {
                "url": "https://amo.sh/XXXXXXXXXXXX",
                "account_id": 123,
                "metadata": {
                    "entity_type": "contacts",
                    "entity_id": 321
                }
            }
        ]
    }
}