Поделиться через

Текстовый запрос

Текстовый запрос — это бизнес-платформа для преобразования взаимодействия с клиентами. Мы создали решение для обмена сообщениями plug-and-play для повседневных проблем связи, чтобы вы могли сократить шум и подключиться к клиентам в любое время, где угодно. Узнайте больше о том, как мы помогаем занятым бизнес-лидерам, как вы.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Поддержка API запросов текста
URL https://www.textrequest.com/contact
Адрес электронной почты apidev@textrequest.com
Метаданные соединителя
Publisher Текстовый запрос
Website https://www.textrequest.com/
Политика конфиденциальности https://www.textrequest.com/privacy-policy/
Категории Коммуникация; Продажи и CRM

Aranda Service Management Suite (ASMS)

Повышение производительности вашей компании и преобразование взаимодействия пользователей с Aranda Service Management Suite, мультитенантное решение, которое позволяет управлять, интегрировать и автоматизировать бизнес-процессы и службы. Создание, поиск и обновление записей, хранящихся в любой рабочей области (проекте) ASMS, включая инциденты, требования и изменения, среди прочего.

Pre-requisites

Имейте в виду следующие предварительные требования для продолжения:

  • Подписка и экземпляр Aranda Service Management Suite (ASMS). Начните с этого: https://arandasoft.com/
  • Активная подписка Microsoft Power Automate с возможностями соединителя Premium.

Получение учетных данных

  • Чтобы выполнить проверку подлинности, используйте маркер интеграции. В следующей ссылке вы найдете сведения о том, как получить маркер интеграции

Начало работы с соединителем

  1. Требуется подписка на Aranda Service Management Suite (ASMS).

  2. Получение маркера интеграции

  3. Получите URL-адрес экземпляра API ASMS для управления службами Aranda (ApiAsms).

  4. Установите подключение к соединителю Aranda Service Management Suite.

  5. Выберите одну из следующих функций, предлагаемых соединителем:

    Билет

  6. Подробные сведения о соединителе см. в этой статье. https://docs.arandasoft.com/connectors

Этот соединитель можно использовать в следующих случаях:

  1. Создание, поиск и обновление билетов, среди других доступных действий.
  2. Получение трассировки билетов.
  3. Скачайте вложения, связанные с билетом.
  4. Найдите статьи базы знаний (КБ) в Aranda Service Management Suite.
  5. Скачайте вложения из статей базы знаний (КБ).
  6. Создание, поиск и обновление элементов конфигурации (CIs).
  7. Она позволяет организациям разрешать свои внутренние запросы на поддержку, управлять и оптимизировать процесс устранения технических проблем.
  8. Позволяет отслеживать обмен данными между запрашивателями и агентами поддержки.
  9. Предложите автоматические ответы, чтобы сообщить запрашивателям о состоянии своего билета.

Успешный ответ

Code Имя Description
200 ХОРОШО Запрос был успешно выполнен
204 НетКонтент Нет данных, найденных в запросе

Распространенные ошибки и средства устранения неполадок

Code Имя Description Solution
400 Неверный запрос CriteriaNeedsSomeArguments Убедитесь, что параметры поиска не пусты
400 Неверный запрос InvalidAdditionalFieldId Убедитесь, что идентификаторы дополнительных полей верны
400 Неверный запрос InvalidItemType Неверный тип регистра, изменение идентификатора типа регистра
400 Неверный запрос InvalidProjectId Неверный идентификатор проекта, измените идентификатор проекта, на который будет связан случай.
400 Неверный запрос InvalidStateId Проверьте добавленное состояние при создании или обновлении билета
400 Неверный запрос InvalidUploadType Ошибка при присоединении файла, запрос помощи от системного администратора
400 Неверный запрос RequestNeedsSomeArguments Проверьте обязательные поля билета и добавьте соответствующее значение этих значений в соединитель.
400 Неверный запрос SearchListIsRequired Запрос помощи от системного администратора
400 Неверный запрос Имя параметра: {Параметр Name} Убедитесь, что свойства, упомянутые в ошибке, не являются null
400 Неверный запрос Имеет значение NULL- имя параметра: {Name parameter} Убедитесь, что свойства, упомянутые в ошибке, не являются null
400 Неверный запрос ItemTypeIsRequired Добавление типа регистра
400 Неверный запрос ModelIdIsEmpty Добавьте параметр modelId. Это обязательно.
400 Неверный запрос StateIdIsEmpty Добавьте параметр stateId. Это обязательно.
400 Неверный запрос ServiceIdIsEmpty Добавьте параметр ServiceId. Это обязательно.
400 Неверный запрос CategoryIdIsEmpty Добавьте параметр categoryId. Это обязательно.
400 Неверный запрос TypesListNeedsSomeArguments Требуется добавить тип случая при поиске билетов, запрос помощи от системного администратора
400 Неверный запрос "{PARAMETER_NAME}" AdditionalFieldIsRequired Дополнительное поле "{PARAMETER_NAME}" является обязательным
400 Неверный запрос ModelNotActive Модель, связанная с делом, не активна
400 Неверный запрос FailedToCloseTaskPendingCloseTasksPredecesors Если вы попытаетесь закрыть дело и родительский случай имеет ожидающие задачи, чтобы закрыть
400 Неверный запрос Повторяющийся объектObject Ci уже существует в базе данных
400 Неверный запрос Имя параметра EmptyValue: {PARAMETER_NAME} Обязательный параметр {PARAMETER_NAME}
400 Неверный запрос Имя параметра EmptyEnumeration: {PARAMETER_NAME} Параметр {PARAMETER_NAME} является списком и является обязательным.
Ошибка 403: Доступ запрещён Запрещено DoNotHavePermissionForThisAction Обратитесь к системным администратору, чтобы назначить разрешения
Code Имя Description Solution
500 ВнутренняяОшибкаСервера Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureExportExcel Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetAdditionalFields Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetCategoriesByService Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetChangeFSC Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetFields Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetFieldsList Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetFiles Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetLookupValues Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetMailTemplates Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetModelByCategory Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetOperator Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetReassignmentReasons Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureGetSimilarItems Запрос помощи от системного администратора
500 ВнутренняяОшибкаСервера FailureSearchQuickManagement Запрос помощи от системного администратора

Часто задаваемые вопросы

  1. Как получить идентификаторы атрибутов, необходимых для использования различных действий в соединителе (например, проект, служба, категория, группа, специалист)?

    Идентификаторы можно получить различными способами:

    • С помощью диспетчера запросов Aranda можно создать отчет, который запрашивает таблицу Aranda Service Management Suite (ASMS), в которой находятся необходимые данные. Если вам нужна рекомендация по объектам данных в решении, перейдите по следующей ссылке https://docs.arandasoft.com/docs/database.html и определите версию базы данных Aranda, соответствующую установке ASMS.
    • Если вы используете локальную установку ASMS, вы можете запросить таблицу ASMS, в которой необходимые данные находятся через клиент SQL.
    • С помощью Центра поддержки Aranda создайте запрос на поддержку через каналы контактов, указанные на следующем веб-сайте.

  2. Какой максимальный размер файлов требуется вложить при использовании действия "Добавить вложение"?

    Максимальный размер зависит от конкретной конфигурации экземпляра или установки ASMS. Попросите администратора ASMS.

  3. Какой уровень доступа к данным требуется учетной записи технического специалиста, маркер которой используется в конфигурации подключения ASMS, необходимого соединителю?

    Уровень доступа совпадает с учетной записью технического специалиста, используемой в ASMS на регулярной основе. Другими словами, на основе ролей и разрешений соответствующего технического специалиста в ASMS данные можно получить с помощью соединителя.

  4. Должна ли учетная запись технического специалиста, маркер которой будет использоваться в соединителе, иметь имя или параллельное использование?

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

  5. Следует ли создавать или изменять варианты, использующие соединитель, те же правила проверки данных, которые присутствуют в интерфейсе ASMS?

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

  6. Можно ли использовать соединитель для экземпляров ASMS в облачных и локальных средах?

    Да, его можно использовать как в облачных, так и в локальных установках ASMS. В локальных установках необходимо рассмотреть возможность подключения между сервером ASMS и средой Power Automate.

  7. У меня есть лицензия Power Automate, которая позволяет использовать только стандартные соединители. Можно ли использовать соединитель ASMS?

    Невозможно, соединитель ASMS является типом Premium.

  8. Я хочу создать потоки в Power Automate, начинающиеся с событий в ASMS (например, при создании дела, когда дело назначается определенной группе). Можно ли использовать триггеры, начинающиеся с событий в ASMS?

    Да, это возможно. Рекомендуется выполнить следующие действия.

    • Инициализируйте триггер "При получении HTTP-запроса" и создайте схему JSON текста запроса, содержащую структуру данных, которая должна быть получена из ASMS. После создания триггера вы получите URL-адрес HTTP POST (URL-адрес веб-перехватчика) для использования в экземпляре ASMS. Не забудьте рассмотреть механизм проверки подлинности для доступа к URL-адресу веб-перехватчика (например, токену).
    • Создайте бизнес-правило в ASMS для набора условий, которые при выполнении должны инициировать поток в Power Automate. В качестве действия в правиле выберите "Вызвать веб-перехватчик" и в URL-адрес назначения вызова введите ранее полученный URL-адрес веб-перехватчика, параметры для отправки и текст запроса (который должен соответствовать схеме JSON текста запроса). Дополнительные сведения о вызове веб-перехватчика из правила в ASMS см. по следующей ссылке: правило веб-перехватчика
    • Проверьте созданное правило и убедитесь, что HTTP-запрос отправляется в URL-адрес веб-перехватчика и инициализирует поток в Power Automate.

  9. Можно ли вызывать конечные точки REST API ASMS в качестве действий из потоков в Power Automate?

    Да, это возможно. Используйте действие HTTP и заполните необходимые данные в нем (URI, метод, заголовки, текст, среди прочего).

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:
По умолчанию Параметры для создания подключения. Все регионы Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя Тип Description Обязательно
Ключ API securestring Ключ API для этого API True

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Архивация беседы

Архивирует беседу, удаляя ее из результатов всех конечных точек извлечения беседы. Беседа будет автоматически неархивирована, если клиент отправляет текст в номер текстового запроса или отправляете клиенту текст из номера текстового запроса. Архивация бесед является хорошим способом удалить беспорядок от клиентов, с которые вы не планируете говорить в будущем. Обратите внимание, что если текст клиента в "STOP", чтобы предотвратить отправку их дальнейших SMS-сообщений, беседа автоматически архивируется.
Возвращает все беседы для этой панели мониторинга

Получает все беседы для этой панели мониторинга и содержит сведения о последнем сообщении для каждой беседы.
Возвращает все группы

Возвращает все группы для учетной записи пользователя.
Возвращает все настраиваемые поля

Возвращает все настраиваемые поля для этой панели мониторинга. Пользовательские поля уникальны между панелями мониторинга.
Возвращает все теги

Возвращает все теги для этой панели мониторинга. Теги уникальны между панелями мониторинга.
Возвращает контакт с указанным номером телефона

Возвращает контакт с указанным номером телефона
Возвращает платеж с указанным идентификатором

Возвращает платеж с указанным идентификатором.
Контакты массового обновления

Только указанная панель мониторинга будет добавлять контакты; контакты упорядочены по панели мониторинга, и нет поиска на уровне учетной записи для получения количества доступных.
Обновление имени определенной панели мониторинга

Обновляет панель мониторинга. Это не изменяет номер телефона панели мониторинга. Если вы хотите создать новый номер с контактами другой панели мониторинга, необходимо создать новую панель мониторинга с помощью POST и добавить контакты с массовым экспортом и импортом.
Обновляет группу с заданным идентификатором

Обновляет имя группы с помощью числового идентификатора группы. Если переданный идентификатор группы не существует, вызов завершится ошибкой.
Отменяет указанный платеж

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

Отправляет напоминание контакту для оплаты указанного платежа. Содержимое сообщения создается автоматически. Чтобы избежать нежелательной почты, можно отправить только одно напоминание на оплату
Отправка сообщения контакту с указанным номером телефона

Отправляет сообщение (запуск новой беседы, если указанный номер телефона не имеет журнала сообщений).
Получает все платежи

Получает все платежи, включая отмененные и платные платежи. Их можно отфильтровать с помощью параметров запроса.
Получение всех контактов, соответствующих указанному критерию фильтрации

Возвращает все контакты, соответствующие указанному критерию фильтрации. Поиск будет выполнен только на указанной панели мониторинга; Нет доступа к уровню учетной записи.
Получение всех панелей мониторинга в учетной записи

Возвращает все панели мониторинга в учетной записи.
Получение группы по идентификатору

Возвращает группу с указанным идентификатором.
Получение сведений на этой конкретной панели мониторинга

Возвращает имя и телефон панели мониторинга.
Получение сообщений беседы по номеру телефона контакта

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

Закрывает платеж по мере оплаты. Используйте эту конечную точку для оплаты за счет средств, отличных от портала запроса на оплату. Это закроет платеж и добавит его сумму платежа в статистику. Эта конечная точка не требуется для оплаты через портал платежей, отправленный с помощью текстового запроса; это автоматически помечает оплату по мере оплаты.
Разархивная беседа

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

Создает новую группу с указанным именем.
Создает новый платеж

Создает новый платеж с предоставленным сообщением для предоставленного контакта.
Создание или обновление контакта

Создает или обновляет контакт (в зависимости от того, существует ли он с указанным номером телефона).
Создание панели мониторинга с заданным именем и номером телефона

Создает новую панель мониторинга в учетной записи. После создания панели мониторинга администраторы будут отправлять сообщения электронной почты об изменении и приступить к назначению пользователей. Эта конечная точка может сделать панель мониторинга для любых подготовленных чисел. Вы можете искать подготовленные номера в определенном коде области с помощью GET /dashboards/provisioning. Если номер телефона уже используется, будет создано исключение "Недопустимый запрос".
Удаляет группу с указанным идентификатором

Удаляет группу с указанным идентификатором. Это завершится успешно, даже если есть контакты, которые являются членами группы (контакты не будут удалены).
Удаляет контакт с указанным номером телефона

Удаляет контакт с указанным номером телефона
Удаляет указанную панель мониторинга

Удаляет указанную панель мониторинга.

Архивация беседы

Идентификатор операции:
ArchiveConversation

Архивирует беседу, удаляя ее из результатов всех конечных точек извлечения беседы. Беседа будет автоматически неархивирована, если клиент отправляет текст в номер текстового запроса или отправляете клиенту текст из номера текстового запроса. Архивация бесед является хорошим способом удалить беспорядок от клиентов, с которые вы не планируете говорить в будущем. Обратите внимание, что если текст клиента в "STOP", чтобы предотвратить отправку их дальнейших SMS-сообщений, беседа автоматически архивируется.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона беседы
 phone_number True string

Номер телефона беседы для архивирования.

Возвращаемое значение

response
string

Возвращает все беседы для этой панели мониторинга

Идентификатор операции:
GetConversations

Получает все беседы для этой панели мониторинга и содержит сведения о последнем сообщении для каждой беседы.

Параметры

Имя Ключ Обязательно Тип Описание
Теги контактов
 tags string

Разделенный запятыми список guid, ссылающийся на теги для фильтрации бесед.
Отображение только разрешенных бесед
 show_unresolved_only string

Следует ли искать только контакты, беседы которых были разрешены. Если это значение false, будут отображаться как разрешенные, так и неразрешенные беседы.
Следует ли включать архивные беседы
 include_archived string

Следует ли включать беседы с контактами, которые были архивированы.
Термин для фильтрации по номерам телефонов и имени контакта
 search string

Термин поиска для фильтрации бесед по номеру телефона или отображаемого имени. Если условие поиска меньше полного имени или номера телефона, поиск вернет все беседы, которые частично соответствуют ему.
Страница номера для получения
 page integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size integer

Размер каждой страницы для получения. При получении значений это максимальный размер на страницу с доступом к последующим страницам, выполненным параметром страницы.
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей беседы, полученных из текстового запроса.
номер телефона
 items.phone_number string

Номер телефона контакта.
message_id
 items.last_message.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 items.last_message.body string

Содержимое этого сообщения.
message_direction
 items.last_message.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 items.last_message.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 items.last_message.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 items.last_message.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 items.last_message.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 items.last_message.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Возвращает все группы

Идентификатор операции:
GetGroups

Возвращает все группы для учетной записи пользователя.

Параметры

Имя Ключ Обязательно Тип Описание
Страница номера для получения
 page True integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size True integer

Размер каждой страницы для получения. При получении значений это максимальный размер на страницу с доступом к последующим страницам, выполненным параметром страницы.
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей группы, полученных из текстового запроса.
id
 items.id integer

Числовый идентификатор группы.
group_member_count
 items.group_member_count integer

Количество членов группы.
is_keyword
 items.is_keyword boolean

Wheter эта группа является группой ключевых слов. Такие группы создаются автоматически при настройке ключевого слова пользователем. Контакты добавляются автоматически при регистрации.
имя
 items.name string

Имя этой группы.
заметки
 items.notes string

Любые заметки в этой группе.
last_message_sent_utc
 items.last_message_sent_utc string

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

Возвращает все настраиваемые поля

Идентификатор операции:
GetCustomFields

Возвращает все настраиваемые поля для этой панели мониторинга. Пользовательские поля уникальны между панелями мониторинга.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
array of object
id
 id string

Числовый идентификатор поля.
имя
 name string

Имя настраиваемого поля.

Возвращает все теги

Идентификатор операции:
GetTags

Возвращает все теги для этой панели мониторинга. Теги уникальны между панелями мониторинга.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Страница номера для получения
 page True integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size True integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей тегов, полученных из текстового запроса.
id
 items.id string

Числовый идентификатор тега.
tag_color
 items.tag_color string

Цвет тега. Это должен быть допустимый шестнадцатеричный код цвета.
tag
 items.tag string

Имя тега.

Возвращает контакт с указанным номером телефона

Идентификатор операции:
GetContactByPhoneNumber

Возвращает контакт с указанным номером телефона

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона контакта
 phone_number True string

Номер телефона для получения контакта.

Возвращаемое значение

Имя Путь Тип Описание
номер телефона
 phone_number string

Номер телефона этого контакта.
first_name
 first_name string

Имя этого контакта.
last_name
 last_name string

Фамилия этого контакта.
display_name
 display_name string

Полное имя этого контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
is_suppressed
 is_suppressed boolean

Если беседа с этим контактом подавляется, поэтому не отправляется в верхнюю часть очереди сообщений при получении.
is_archived
 is_archived boolean

Архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
is_blocked
 is_blocked boolean

Блокируется ли беседа с этим контактом и, следовательно, не получена или сохранена.
suppressed_reason
 suppressed_reason string

Фраза, описывающая причину подавления контакта. Если is_suppressed имеет значение false, это значение равно NULL.
заметка
 note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
groups
 groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой принадлежит этот контакт.
contact_tags
 contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
custom_fields
 custom_fields array of object

Массив идентификаторов и значений настраиваемых полей, определенных для этого контакта.
id
 custom_fields.id string

Guid, ссылающийся на настраиваемое поле.
value
 custom_fields.value string

Значение этого контакта для этого настраиваемого поля.
is_resolved
 is_resolved boolean

Разрешена ли беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.
first_contact_utc
 first_contact_utc string

Метка времени отправки первого сообщения этому контакту.
opted_out_utc
 opted_out_utc string

Метка времени, когда этот контакт отказался получать сообщения.
last_msg_sent_utc
 last_msg_sent_utc string

Метка времени отправки последнего сообщения этому контакту.
last_msg_received_utc
 last_msg_received_utc string

Метка времени получения последнего сообщения от этого контакта.
total_msgs_sent
 total_msgs_sent integer

Общее количество сообщений, отправленных этому контакту.
total_msgs_received
 total_msgs_received integer

Общее количество сообщений, полученных от этого контакта.
response_count
 response_count integer

Общее количество сообщений ответа от контакта.
date_created_utc
 date_created_utc string

Метка времени создания контакта ths.
last_contact_date_utc
 last_contact_date_utc string

Метка времени отправки или получения последнего сообщения от этого контакта.
message_id
 last_message.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 last_message.body string

Содержимое этого сообщения.
message_direction
 last_message.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 last_message.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 last_message.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 last_message.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 last_message.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 last_message.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Возвращает платеж с указанным идентификатором

Идентификатор операции:
GetPayment

Возвращает платеж с указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор платежа
 payment_id True integer

Числовой идентификатор получения платежа.

Возвращаемое значение

Имя Путь Тип Описание
payment_id
 payment_id integer

Числовый идентификатор платежа.
request_date
 request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Контакты массового обновления

Идентификатор операции:
BulkUpdateContacts

Только указанная панель мониторинга будет добавлять контакты; контакты упорядочены по панели мониторинга, и нет поиска на уровне учетной записи для получения количества доступных.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона контакта
 phone_number string

Номер телефона контакта для создания или обновления.
Имя контакта
 first_name string

Новое имя контакта.
Фамилия контакта
 last_name string

Новое фамилию контакта.
Полное имя контакта
 display_name string

Новое полное имя контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
Подавляются ли сообщения от этого контакта
 is_suppressed boolean

Определяет, подавляются ли беседы с этим контактом и поэтому не отправляются в верхнюю часть очереди сообщений при получении.
Архивируются ли сообщения из этого контакта
 is_archived boolean

Определяет, архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
Заблокированы ли сообщения от этого контакта
 is_blocked boolean

Определяет, блокируются ли беседы с этим контактом и поэтому не получены или сохранены.
Причина подавления этого контакта
 suppressed_reason string

Фраза, описывающая причину подавления контакта.
Примечание к контакту
 note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
Группы контактов
 groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой относится этот контакт.
Теги контактов
 contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
Идентификатор настраиваемого поля
 id string

Guid, ссылающийся на настраиваемое поле.
Значение настраиваемого поля
 value string

Значение этого контакта для этого настраиваемого поля.
Разрешена ли текущая беседа с этим контактом
 is_resolved boolean

Определяет, разрешена ли текущая беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.

Возвращаемое значение

Имя Путь Тип Описание
array of object
номер телефона
 phone_number string

Номер телефона этого контакта.
first_name
 first_name string

Имя этого контакта.
last_name
 last_name string

Фамилия этого контакта.
display_name
 display_name string

Полное имя этого контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
is_suppressed
 is_suppressed boolean

Если беседа с этим контактом подавляется, поэтому не отправляется в верхнюю часть очереди сообщений при получении.
is_archived
 is_archived boolean

Архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
is_blocked
 is_blocked boolean

Блокируется ли беседа с этим контактом и, следовательно, не получена или сохранена.
suppressed_reason
 suppressed_reason string

Фраза, описывающая причину подавления контакта. Если is_suppressed имеет значение false, это значение равно NULL.
заметка
 note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
groups
 groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой принадлежит этот контакт.
contact_tags
 contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
custom_fields
 custom_fields array of object

Массив идентификаторов и значений настраиваемых полей, определенных для этого контакта.
id
 custom_fields.id string

Guid, ссылающийся на настраиваемое поле.
value
 custom_fields.value string

Значение этого контакта для этого настраиваемого поля.
is_resolved
 is_resolved boolean

Разрешена ли беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.
first_contact_utc
 first_contact_utc string

Метка времени отправки первого сообщения этому контакту.
opted_out_utc
 opted_out_utc string

Метка времени, когда этот контакт отказался получать сообщения.
last_msg_sent_utc
 last_msg_sent_utc string

Метка времени отправки последнего сообщения этому контакту.
last_msg_received_utc
 last_msg_received_utc string

Метка времени получения последнего сообщения от этого контакта.
total_msgs_sent
 total_msgs_sent integer

Общее количество сообщений, отправленных этому контакту.
total_msgs_received
 total_msgs_received integer

Общее количество сообщений, полученных от этого контакта.
response_count
 response_count integer

Общее количество сообщений ответа от контакта.
date_created_utc
 date_created_utc string

Метка времени создания контакта ths.
last_contact_date_utc
 last_contact_date_utc string

Метка времени отправки или получения последнего сообщения от этого контакта.
message_id
 last_message.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 last_message.body string

Содержимое этого сообщения.
message_direction
 last_message.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 last_message.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 last_message.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 last_message.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 last_message.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 last_message.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Обновление имени определенной панели мониторинга

Идентификатор операции:
UpdateDashboardsName

Обновляет панель мониторинга. Это не изменяет номер телефона панели мониторинга. Если вы хотите создать новый номер с контактами другой панели мониторинга, необходимо создать новую панель мониторинга с помощью POST и добавить контакты с массовым экспортом и импортом.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Имя панели мониторинга
 name string

Новое имя панели мониторинга.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор панели мониторинга.
имя
 name string

Имя панели мониторинга.
phone
 phone string

Текстовый номер, связанный с этой панелью мониторинга.

Обновляет группу с заданным идентификатором

Идентификатор операции:
UpdateGroup

Обновляет имя группы с помощью числового идентификатора группы. Если переданный идентификатор группы не существует, вызов завершится ошибкой.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор группы
 group_id True integer

Числовый идентификатор группы для обновления.
Имя группы
 name string

Новое имя группы.
Примечание группы
 notes string

Короткая фраза, описывающая группу. Используется для удобства.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор группы.
group_member_count
 group_member_count integer

Количество членов группы.
is_keyword
 is_keyword boolean

Wheter эта группа является группой ключевых слов. Такие группы создаются автоматически при настройке ключевого слова пользователем. Контакты добавляются автоматически при регистрации.
имя
 name string

Имя этой группы.
заметки
 notes string

Любые заметки в этой группе.
last_message_sent_utc
 last_message_sent_utc string

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

Отменяет указанный платеж

Идентификатор операции:
CancelPayment

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор платежа
 payment_id True integer

Числовый идентификатор платежа для обновления.

Возвращаемое значение

Имя Путь Тип Описание
payment_id
 payment_id integer

Числовый идентификатор платежа.
request_date
 request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Отправка следующего текста, напоминающего пользователю о оплате указанного платежа

Идентификатор операции:
SendPaymentReminder

Отправляет напоминание контакту для оплаты указанного платежа. Содержимое сообщения создается автоматически. Чтобы избежать нежелательной почты, можно отправить только одно напоминание на оплату

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор платежа
 payment_id True integer

Числовый идентификатор платежа для обновления.

Возвращаемое значение

Имя Путь Тип Описание
payment_id
 payment_id integer

Числовый идентификатор платежа.
request_date
 request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Отправка сообщения контакту с указанным номером телефона

Идентификатор операции:
SendMessageByPhoneNumber

Отправляет сообщение (запуск новой беседы, если указанный номер телефона не имеет журнала сообщений).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона в сообщение
 phone_number True string

Номер телефона контакта для отправки сообщения.
Текст сообщения
 body string

Содержимое сообщения для отправки.
Имя отправителя
 sender_name string

Имя отправителя сообщения. Это отображается в веб-приложении TextRequest и API при получении этого сообщения.
URL-адрес обратного вызова при обновлении состояния сообщения
 status_callback string

URL-адрес веб-приложения для попадания с помощью команды POST всякий раз, когда состояние этого сообщения переходит от незавершенного до отправки (или ошибки).
URL-адрес обратного вызова для запросов расположения, если это сообщение содержит одно из них
 location_callback string

URL-адрес обратного вызова расположения, чтобы получить доступ к команде POST, когда пользователь обращается к своему расположению и утверждает предоставление общего доступа к своему расположению отправителю. Чтобы включить ссылку, добавьте [запрос расположения] в текст сообщения. Этот обратный вызов не требуется для запросов расположения, но он может быть полезным для API.
Вложения мультимедиа MMS для этого сообщения
 mms_media array of string

Массив вложений мультимедиа MMS для этого сообщения. Вложения должны быть URL-адресами, полученными из конечной точки записи /mms (не включенной в этот соединитель). Внешние ссылки на вложение не будут приниматься.

Возвращаемое значение

Имя Путь Тип Описание
message_id
 message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 body string

Содержимое этого сообщения.
message_direction
 message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Получает все платежи

Идентификатор операции:
GetPayments

Получает все платежи, включая отмененные и платные платежи. Их можно отфильтровать с помощью параметров запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Ссылка на строку оплаты
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.
Номер телефона оплаты
 phone_number string

Номер телефона контакта, на который был отправлен этот платеж.
Сортировка по
 sort_type string

Свойство для сортировки платежей по. Может быть "сумма", "контакт", "дата", "состояние".
Направление сортировки
 sort_direction string

Направление сортировки платежей в. Может быть "desc" для наибольшего до наименьшего или "asc" для наименьшего до наибольшего.
Страница номера для получения
 page True integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size True integer

Размер каждой страницы для получения. При получении значений это максимальный размер на страницу с доступом к последующим страницам, выполненным параметром страницы.
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей оплаты, полученных из текстового запроса.
payment_id
 items.payment_id integer

Числовый идентификатор платежа.
request_date
 items.request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 items.recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 items.description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 items.customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 items.amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 items.is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 items.reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 items.transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 items.textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 items.reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Получение всех контактов, соответствующих указанному критерию фильтрации

Идентификатор операции:
GetContacts

Возвращает все контакты, соответствующие указанному критерию фильтрации. Поиск будет выполнен только на указанной панели мониторинга; Нет доступа к уровню учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Номер телефона контакта для поиска по
 contact_phone_number string

Номер телефона для фильтрации контактов по.
Метка времени последнего сообщения, отправленная ранее, в формате UTC
 last_message_timestamp_before_utc date-time

Время отсечения для поиска контактов по последнему сообщению, отправленное или полученное. После этого не будут отображаться контакты, отправляющие сообщения.
"Время последнего сообщения, отправленное после" метки времени поиска в формате UTC
 last_message_timestamp_after_utc date-time

Время отсечения для поиска контактов по последнему сообщению, отправленное или полученное. Контакты, последние отправленные сообщения которых не будут отображаться до этого времени.
Метка времени поиска "Создано до"
 contact_created_before date-time

Время отсечения для поиска контактов по их созданию. Контакты, созданные после этого времени, не будут отображаться.
Метка времени поиска "Создано после"
 contact_created_after date-time

Время отсечения для поиска контактов по их созданию. Контакты, созданные до этого времени, не будут отображаться.
Разрешена ли беседа контакта
 is_resolved boolean

Следует ли искать контакты, беседы которых были разрешены.
Блокируется ли контакт
 is_blocked boolean

Следует ли искать контакты, которые были заблокированы.
Архивируется ли контакт
 is_archived boolean

Следует ли искать контакты, которые были архивированы.
Отключается ли контакт
 is_suppressed boolean

Следует ли искать контакты, которые были подавлены.
Отказались ли контакт
 has_opted_out boolean

Следует ли искать контакты, которые отказались от получения текстов.
Метка времени последнего сообщения, отправленная ранее
 last_message_sent_before date-time

Время отсечения для поиска контактов, когда последнее сообщение было отправлено клиенту. После этого не будут отображаться контакты, отправляющие сообщения. Использует метку времени в качестве локального времени. Чтобы отфильтровать метку времени в формате UTC, используйте last_message_sent_before_utc
Метка времени поиска "Последнее сообщение, отправленное после"
 last_message_sent_after date-time

Время отсечения для поиска контактов, когда последнее сообщение было отправлено клиенту. Контакты, последние отправленные сообщения которых не будут отображаться до этого времени. Использует метку времени в качестве локального времени. Чтобы отфильтровать метку по времени в формате UTC, используйте last_message_sent_after_utc
Метка времени поиска "Последнее сообщение, полученное до"
 last_message_received_before date-time

Время отсечения для поиска контактов по последнему сообщению, полученному от клиента. Контакты, которые получили сообщения после этого времени, не будут отображаться. Использует метку времени в качестве локального времени. Чтобы отфильтровать метку времени в формате UTC, используйте last_message_sent_before_utc
Метка времени последнего сообщения, полученного после поиска
 last_message_received_after date-time

Время отсечения для поиска контактов по последнему сообщению, полученному от клиента. Контакты, последние отправленные сообщения которых не будут отображаться до этого времени. Использует метку времени в качестве локального времени. Чтобы отфильтровать метку времени в формате UTC, используйте last_message_sent_before_utc
Теги контактов
 tags string

Разделенный запятыми список guid, ссылающийся на теги для фильтрации контактов.
Группы контактов
 groups string

Разделенный запятыми список целых чисел, ссылающийся на группы для фильтрации контактов по.
Идентификатор настраиваемого поля для фильтрации по
 custom_field_id_1 string

Guid, ссылающийся на настраиваемое поле для фильтрации контактов.
Значение настраиваемого поля для фильтрации по
 custom_field_value_1 string

Значение, ссылающееся на настраиваемое поле для фильтрации контактов.
Идентификатор второго настраиваемого поля для фильтрации по
 custom_field_id_2 string

Guid, ссылающийся на второе настраиваемое поле для фильтрации контактов по.
Значение второго настраиваемого поля для фильтрации по
 custom_field_value_2 string

Значение, ссылающееся на второе настраиваемое поле для фильтрации контактов по.
Идентификатор третьего настраиваемого поля для фильтрации по
 custom_field_id_3 string

Guid, ссылающийся на третье настраиваемое поле для фильтрации контактов.
Значение третьего настраиваемого поля для фильтрации по
 custom_field_value_3 string

Значение, ссылающееся на третье настраиваемое поле для фильтрации контактов по.
Страница номера для получения
 page True integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size True integer

Размер каждой страницы для получения. При получении значений это максимальный размер на страницу с доступом к последующим страницам, выполненным параметром страницы.
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей контактов, полученных из текстового запроса.
номер телефона
 items.phone_number string

Номер телефона этого контакта.
first_name
 items.first_name string

Имя этого контакта.
last_name
 items.last_name string

Фамилия этого контакта.
display_name
 items.display_name string

Полное имя этого контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
is_suppressed
 items.is_suppressed boolean

Если беседа с этим контактом подавляется, поэтому не отправляется в верхнюю часть очереди сообщений при получении.
is_archived
 items.is_archived boolean

Архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
is_blocked
 items.is_blocked boolean

Блокируется ли беседа с этим контактом и, следовательно, не получена или сохранена.
suppressed_reason
 items.suppressed_reason string

Фраза, описывающая причину подавления контакта. Если is_suppressed имеет значение false, это значение равно NULL.
заметка
 items.note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
groups
 items.groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой принадлежит этот контакт.
contact_tags
 items.contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
custom_fields
 items.custom_fields array of object

Массив идентификаторов и значений настраиваемых полей, определенных для этого контакта.
id
 items.custom_fields.id string

Guid, ссылающийся на настраиваемое поле.
value
 items.custom_fields.value string

Значение этого контакта для этого настраиваемого поля.
is_resolved
 items.is_resolved boolean

Разрешена ли беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.
first_contact_utc
 items.first_contact_utc string

Метка времени отправки первого сообщения этому контакту.
opted_out_utc
 items.opted_out_utc string

Метка времени, когда этот контакт отказался получать сообщения.
last_msg_sent_utc
 items.last_msg_sent_utc string

Метка времени отправки последнего сообщения этому контакту.
last_msg_received_utc
 items.last_msg_received_utc string

Метка времени получения последнего сообщения от этого контакта.
total_msgs_sent
 items.total_msgs_sent integer

Общее количество сообщений, отправленных этому контакту.
total_msgs_received
 items.total_msgs_received integer

Общее количество сообщений, полученных от этого контакта.
response_count
 items.response_count integer

Общее количество сообщений ответа от контакта.
date_created_utc
 items.date_created_utc string

Метка времени создания контакта ths.
last_contact_date_utc
 items.last_contact_date_utc string

Метка времени отправки или получения последнего сообщения от этого контакта.
message_id
 items.last_message.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 items.last_message.body string

Содержимое этого сообщения.
message_direction
 items.last_message.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 items.last_message.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 items.last_message.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 items.last_message.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 items.last_message.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 items.last_message.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Получение всех панелей мониторинга в учетной записи

Идентификатор операции:
GetDashboards

Возвращает все панели мониторинга в учетной записи.

Параметры

Имя Ключ Обязательно Тип Описание
Страница номера для получения
 page integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size integer

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

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей панели мониторинга, полученных из текстового запроса.
id
 items.id integer

Числовый идентификатор панели мониторинга.
имя
 items.name string

Имя панели мониторинга.
phone
 items.phone string

Текстовый номер, связанный с этой панелью мониторинга.

Получение группы по идентификатору

Идентификатор операции:
GetGroupById

Возвращает группу с указанным идентификатором.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор группы
 group_id True integer

Числовой идентификатор группы, который требуется получить.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор группы.
group_member_count
 group_member_count integer

Количество членов группы.
is_keyword
 is_keyword boolean

Wheter эта группа является группой ключевых слов. Такие группы создаются автоматически при настройке ключевого слова пользователем. Контакты добавляются автоматически при регистрации.
имя
 name string

Имя этой группы.
заметки
 notes string

Любые заметки в этой группе.
last_message_sent_utc
 last_message_sent_utc string

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

Получение сведений на этой конкретной панели мониторинга

Идентификатор операции:
GetDashboard

Возвращает имя и телефон панели мониторинга.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор панели мониторинга.
имя
 name string

Имя панели мониторинга.
phone
 phone string

Текстовый номер, связанный с этой панелью мониторинга.

Получение сообщений беседы по номеру телефона контакта

Идентификатор операции:
GetMessagesByContactPhone

Получите беседу между указанной панелью мониторинга и номером телефона.

Параметры

Имя Ключ Обязательно Тип Описание
Страница номера для получения
 page True integer

Страница сущностей для получения. При получении значений на страницу имеется максимальный размер, определенный page_size. Если страница больше последней страницы, возвращается пустой массив.
Количество каждой сущности для получения на страницу
 page_size True integer

Размер каждой страницы для получения. При получении значений это максимальный размер на страницу с доступом к последующим страницам, выполненным параметром страницы.
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона контакта для поиска по
 phone_number True string

Номер телефона контакта для получения сообщений.

Возвращаемое значение

Имя Путь Тип Описание
page
 meta.page integer

Страница созданных сущностей. Количество сущностей на этой странице определяется page_size.
page_size
 meta.page_size integer

Количество сущностей, которые были удалены на этой странице.
total_items
 meta.total_items integer

Количество сущностей, доступных в базе данных, независимо от размера страницы или числа. Чтобы просмотреть другие страницы, измените номер страницы в запросе.
items
 items array of object

Список сущностей сообщения, полученных из текстового запроса.
message_id
 items.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 items.body string

Содержимое этого сообщения.
message_direction
 items.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 items.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 items.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 items.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 items.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 items.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Пометить платеж как платный

Идентификатор операции:
MarkPaymentPaid

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор платежа
 payment_id True integer

Числовый идентификатор платежа для обновления.

Возвращаемое значение

Имя Путь Тип Описание
payment_id
 payment_id integer

Числовый идентификатор платежа.
request_date
 request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Разархивная беседа

Идентификатор операции:
UnarchiveConversation

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона беседы
 phone_number True string

Номер телефона беседы для архивирования.

Возвращаемое значение

response
string

Создает новую группу

Идентификатор операции:
CreateGroup

Создает новую группу с указанным именем.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Имя группы
 name string

Новое имя группы.
Примечание группы
 notes string

Короткая фраза, описывающая группу. Используется для удобства.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор группы.
group_member_count
 group_member_count integer

Количество членов группы.
is_keyword
 is_keyword boolean

Wheter эта группа является группой ключевых слов. Такие группы создаются автоматически при настройке ключевого слова пользователем. Контакты добавляются автоматически при регистрации.
имя
 name string

Имя этой группы.
заметки
 notes string

Любые заметки в этой группе.
last_message_sent_utc
 last_message_sent_utc string

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

Создает новый платеж

Идентификатор операции:
CreatePayment

Создает новый платеж с предоставленным сообщением для предоставленного контакта.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Описание оплаты
 description string

Описание платежа. Описание не отображается контакту и используется только внутренними пользователями для контекста о платежах.
Номер телефона получателя
 customer_phone string

Номер телефона контакта, на который будет отправлен этот платеж.
Сумма запрошена в долларах
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
Текст сообщения оплаты
 message string

Текст сообщения для отправки контакта вместе с ссылкой на оплату.
Ссылка на строку оплаты
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Возвращаемое значение

Имя Путь Тип Описание
payment_id
 payment_id integer

Числовый идентификатор платежа.
request_date
 request_date string

Метка времени отправки первоначального сообщения об этом платеже.
получатель;
 recipient string

Имя получателя оплаты. Это может быть null, если контакт не имеет имени, связанного с их номером телефона.
описание
 description string

Описание платежа. Это не отображается контакту. Он используется только внутренними пользователями для контекста о платежах.
customer_phone
 customer_phone string

Номер телефона контактного лица, который отправляет этот платеж.
amount_requested
 amount_requested float

Сумма в долларах, запрошенная этим платежом.
is_past_due
 is_past_due boolean

Является ли этот платеж прошлым датой запроса.
reminder_was_sent
 reminder_was_sent boolean

Будет ли отправлено текстовое напоминание об этом платеже.
transaction_status
 transaction_status string

Состояние транзакции в authvia. Это значение начинается как неизвестное.
textrequest_payment_status
 textrequest_payment_status string

Состояние транзакции в текстовом запросе. Это означает, что состояние, отображаемое на странице оплаты в приложении "Текстовый запрос". Он начинается как Sent.
reference_number
 reference_number string

Определяемый пользователем идентификатор, определенный при создании платежей, который можно использовать для быстрого поиска платежей. Ссылочные номера не являются уникальными; Многие платежи могут иметь одну и ту же ссылку.

Создание или обновление контакта

Идентификатор операции:
CreateContact

Создает или обновляет контакт (в зависимости от того, существует ли он с указанным номером телефона).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона контакта
 phone_number True string

Номер телефона контакта для создания или обновления.
Имя контакта
 first_name string

Новое имя контакта.
Фамилия контакта
 last_name string

Новое фамилию контакта.
Полное имя контакта
 display_name string

Новое полное имя контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
Подавляются ли сообщения от этого контакта
 is_suppressed boolean

Определяет, подавляются ли беседы с этим контактом и поэтому не отправляются в верхнюю часть очереди сообщений при получении.
Архивируются ли сообщения из этого контакта
 is_archived boolean

Определяет, архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
Заблокированы ли сообщения от этого контакта
 is_blocked boolean

Определяет, блокируются ли беседы с этим контактом и поэтому не получены или сохранены.
Причина подавления этого контакта
 suppressed_reason string

Фраза, описывающая причину подавления контакта.
Примечание контакта
 note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
Группы контактов
 groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой относится этот контакт.
Теги контактов
 contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
Идентификатор настраиваемого поля
 id string

Guid, ссылающийся на настраиваемое поле.
Значение настраиваемого поля
 value string

Значение этого контакта для этого настраиваемого поля.
Разрешена ли текущая беседа с этим контактом
 is_resolved boolean

Определяет, разрешена ли текущая беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.

Возвращаемое значение

Имя Путь Тип Описание
номер телефона
 phone_number string

Номер телефона этого контакта.
first_name
 first_name string

Имя этого контакта.
last_name
 last_name string

Фамилия этого контакта.
display_name
 display_name string

Полное имя этого контакта. Это имя по умолчанию, отображаемое в веб-приложении при просмотре контактов.
is_suppressed
 is_suppressed boolean

Если беседа с этим контактом подавляется, поэтому не отправляется в верхнюю часть очереди сообщений при получении.
is_archived
 is_archived boolean

Архивируются ли беседы с этим контактом и поэтому не могут быть замечены при запросе бесед (по умолчанию).
is_blocked
 is_blocked boolean

Блокируется ли беседа с этим контактом и, следовательно, не получена или сохранена.
suppressed_reason
 suppressed_reason string

Фраза, описывающая причину подавления контакта. Если is_suppressed имеет значение false, это значение равно NULL.
заметка
 note string

Короткая фраза, описывающая контакт. Используется для удобства. Это никогда не отображается контакту.
groups
 groups array of integer

Массив целых идентификаторов, ссылающихся на группы, к которой принадлежит этот контакт.
contact_tags
 contact_tags array of string

Массив guid, ссылающийся на теги, присоединенные к этому контакту.
custom_fields
 custom_fields array of object

Массив идентификаторов и значений настраиваемых полей, определенных для этого контакта.
id
 custom_fields.id string

Guid, ссылающийся на настраиваемое поле.
value
 custom_fields.value string

Значение этого контакта для этого настраиваемого поля.
is_resolved
 is_resolved boolean

Разрешена ли беседа с этим контактом. Все новые тексты, полученные этим контактом, будут устанавливать это значение false.
first_contact_utc
 first_contact_utc string

Метка времени отправки первого сообщения этому контакту.
opted_out_utc
 opted_out_utc string

Метка времени, когда этот контакт отказался получать сообщения.
last_msg_sent_utc
 last_msg_sent_utc string

Метка времени отправки последнего сообщения этому контакту.
last_msg_received_utc
 last_msg_received_utc string

Метка времени получения последнего сообщения от этого контакта.
total_msgs_sent
 total_msgs_sent integer

Общее количество сообщений, отправленных этому контакту.
total_msgs_received
 total_msgs_received integer

Общее количество сообщений, полученных от этого контакта.
response_count
 response_count integer

Общее количество сообщений ответа от контакта.
date_created_utc
 date_created_utc string

Метка времени создания контакта ths.
last_contact_date_utc
 last_contact_date_utc string

Метка времени отправки или получения последнего сообщения от этого контакта.
message_id
 last_message.message_id string

Идентификатор сообщения. Это значение уникально для каждого сообщения.
body
 last_message.body string

Содержимое этого сообщения.
message_direction
 last_message.message_direction string

Сингулярный символ, либо R или S, обозначающий, получено ли это сообщение от контакта или отправлено им соответственно.
response_by_username
 last_message.response_by_username string

Имя пользователя текстового запроса, которое последний раз отправило этому пользователю сообщение.
message_timestamp_utc
 last_message.message_timestamp_utc string

Метка времени отправки или получения сообщения текстовым запросом.
delivery_status
 last_message.delivery_status string

Текущее состояние этого сообщения. Это может быть "отправка", "доставлено", "ошибка" или "отправить".
delivery_error
 last_message.delivery_error string

Ошибка, которая привела к тому, что это сообщение не будет доставлено. Если delivery_status не является ошибкой, это значение будет иметь значение NULL.
mms_media
 last_message.mms_media array of string

Список URL-адресов, указывающих на вложения этого сообщения. Все URL-адреса будут url-адресами, созданными текстовым запросом.

Создание панели мониторинга с заданным именем и номером телефона

Идентификатор операции:
CreateDashboard

Создает новую панель мониторинга в учетной записи. После создания панели мониторинга администраторы будут отправлять сообщения электронной почты об изменении и приступить к назначению пользователей. Эта конечная точка может сделать панель мониторинга для любых подготовленных чисел. Вы можете искать подготовленные номера в определенном коде области с помощью GET /dashboards/provisioning. Если номер телефона уже используется, будет создано исключение "Недопустимый запрос".

Параметры

Имя Ключ Обязательно Тип Описание
имя
 name string

Имя панели мониторинга.
phone
 phone string

Текстовый номер, связанный с этой панелью мониторинга.

Возвращаемое значение

Имя Путь Тип Описание
id
 id integer

Числовый идентификатор панели мониторинга.
имя
 name string

Имя панели мониторинга.
phone
 phone string

Текстовый номер, связанный с этой панелью мониторинга.

Удаляет группу с указанным идентификатором

Идентификатор операции:
DeleteGroup

Удаляет группу с указанным идентификатором. Это завершится успешно, даже если есть контакты, которые являются членами группы (контакты не будут удалены).

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Идентификатор группы
 group_id True integer

Числовой идентификатор группы для удаления.

Возвращаемое значение

response
string

Удаляет контакт с указанным номером телефона

Идентификатор операции:
DeleteContact

Удаляет контакт с указанным номером телефона

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

Панель мониторинга номера телефона для работы. У одной учетной записи может быть несколько панелей мониторинга, представляющих разные телефонные линии для клиентов.
Номер телефона контакта
 phone_number True string

Номер телефона для удаления контакта.

Возвращаемое значение

response
string

Удаляет указанную панель мониторинга

Идентификатор операции:
DeleteDashboard

Удаляет указанную панель мониторинга.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор панели мониторинга для вызова
 dashboard_id True integer

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

Возвращаемое значение

response
string

Триггеры

Триггеры при отправке или получении текста

Триггеры при отправке или получении текста

Триггеры при отправке или получении текста

Идентификатор операции:
TextingWebhook

Триггеры при отправке или получении текста

Параметры

Имя Ключ Обязательно Тип Описание
Панель мониторинга триггер будет прослушивать события из
 dashboard_id True string

Идентификатор панели мониторинга для добавления триггера в
событие
 event True string

событие

Возвращаемое значение

Имя Путь Тип Описание
Уникальный идентификатор сообщения
 messageUniqueIdentifier string

messageUniqueIdentifier
Идентификатор учетной записи
 account.id integer

id
ИД разговора
 yourPhoneNumber.id integer

id
Имя панели мониторинга
 yourPhoneNumber.description string

описание
Номер телефона панели мониторинга
 yourPhoneNumber.phoneNumber string

номер телефона
Идентификатор панели мониторинга
 conversation.id integer

id
date
 conversation.date string

date
Контактный номер телефона
 conversation.consumerPhoneNumber string

consumerPhoneNumber
messageDirection
 conversation.messageDirection string

messageDirection
сообщение
 conversation.message string

сообщение
numSegments
 conversation.numSegments integer

numSegments
статус
 conversation.status string

статус
Беседа утверждается
 conversation.claimedBy string

claimedBy
Отображаемое имя контакта
 conversation.consumerFriendlyName string

consumerFriendlyName

Определения

струна

Это базовый тип данных string.