JAICP

$dialer.getPayload


При добавлении телефонного номера в обзвон для каждого номера могут быть указаны различные дополнительные данные.

  • При создании обзвона вы можете указать список номеров, на которые требуется позвонить. Все столбцы таблицы, кроме первого, интерпретируются как дополнительные данные.
  • При добавлении номеров в уже созданный обзвон через метод POST /addPhones Calls API вы можете передать объект с дополнительными данными в поле payload.

Метод $dialer.getPayload позволяет получить доступ к этим данным из сценария.


Синтаксис

Метод вызывается без аргументов:

$dialer.getPayload();

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

  • Если номер был добавлен в обзвон через Calls API, возвращаемый объект полностью соответствует JSON-объекту, переданному в запросе.
  • Если номер был добавлен через список номеров, ключи возвращаемого объекта соответствуют названиям столбцов, а значения — значениям ячеек столбцов в строке для данного номера.

Использование в сценарии

Допустим, при создании обзвона загружен следующий список номеров:

phone name address
9990000000 Иван Москва

Вызов метода $dialer.getPayload вернет следующий объект:

{
  "phone": "9990000000",
  "name": "Иван",
  "address": "Москва"
}

Если список номеров загружен без заголовков, ключи представляют собой числа, начиная с 0:

{
  "0": "9990000000",
  "1": "Иван",
  "2": "Москва"
}

Если ячейка в одном из столбцов пустая, по соответствующему ключу метод вернет пустую строку:

{
  "phone": "9990000000",
  "name": "Иван",
  "address": ""
}

Пример использования метода в сценарии:

state: WhatIsMyName
    intent!: /WhatIsMyName
    if: $dialer.getPayload().name
        a: Вас зовут {{$dialer.getPayload().name}}.
    else:
        a: Я не знаю вашего имени.