ClickSend
ClickSend для бизнеса SMS, который получает доставку; оповещения, уведомления, приглашения, маркетинговые сообщения и многое другое. ClickSend — это программное обеспечение для бизнес-коммуникаций, позволяющее компаниям всех форм и размеров легко отправлять и получать SMS, электронную почту, голосовую связь и даже публиковать по всему миру через веб-приложение или API. ClickSend имеет SMS в своей основе и полномочия миллиарды сообщений по всему миру через прямые маршруты, но расширили, чтобы предложить полный набор продуктов, предоставляющий выбор и контекст для бизнес-коммуникаций.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка SMS clickSend |
| URL | https://www.clicksend.com/au/help |
| Адрес электронной почты | Support@clicksend.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Синч Швеция AB |
| Веб-сайт | https://www.clicksend.com |
| Политика конфиденциальности | https://www.clicksend.com/us/legal/privacy-policy |
| Категории | Коммуникация; Маркетинг |
Соединитель ClickSend для Microsoft Power Automate
Создавайте автоматизированные рабочие процессы между приложениями для синхронизации файлов, получения уведомлений, сбора данных и многого другого с помощью Microsoft Power Automate. Подключите ClickSend с помощью Power Automate, чтобы добавить автоматизированное обмен сообщениями в рабочие процессы практически в любой системе.
Надзарядка сообщений с помощью ClickSend
Соединитель ClickSend позволяет интегрировать мощные возможности обмена сообщениями в автоматизированные рабочие процессы. С помощью нескольких щелчков вы можете подключить ClickSend к более чем 700+ соединителям Microsoft Power Automate, чтобы создать простые потоки связи.
Ключевые функции
- Отправка SMS — автоматически отправлять SMS-сообщения, активированные событиями в других приложениях (например, отправки форм, обновления календаря, сообщения электронной почты).
- Отправка MMS — предоставление общего доступа к мультимедийным содержимому, например изображениям или файлам с помощью автоматизированных рабочих процессов.
- Отправка голосовой связи — используйте текстовые или звуковые файлы для доставки голосовых звонков.
- Отправка факса — отправка цифровых факсов непосредственно из потоков.
- Send Post — автоматически отправлять письма или открытки через почтовые службы.
Примеры вариантов использования
- Получение SMS при добавлении или изменении собрания в календаре.
- Получите текстовое уведомление при получении сообщения электронной почты от VIP-клиента.
- Отправьте MMS из ClickSend при отправке нового файла в Dropbox.
- Автоматизация маркетингового или клиентского взаимодействия с помощью рабочих процессов обмена сообщениями с шаблонами.
- Управление списками контактов или реагирование на входящие SMS-сообщения с помощью пользовательских триггеров.
Используйте готовые шаблоны для упрощения настройки или создания собственных пользовательских автоматизации с легкостью.
Подключение учетной записи ClickSend
- Перейдите на панель мониторинга Power Automate .
- Перейдите к новому подключению к данным >>.
- Найдите sms ClickSend.
- Введите учетные данные API ClickSend:
-
username: имя пользователя учетной записи ClickSend -
api_key: ключ API из панели мониторинга ClickSend
-
- Нажмите кнопку "Создать " — ваша учетная запись подключена!
Требования
- Учетная запись ClickSend (регистрация по clicksend.com).
- Учетные данные API (имя пользователя и ключ API).
Подробнее
Посетите портал разработчика ClickSend , чтобы изучить все возможности API и варианты использования.
Улучшение рабочих процессов с помощью автоматизированного обмена сообщениями с помощью ClickSend и Microsoft Power Automate.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Имя пользователя | securestring | Имя пользователя для этого API | True |
| Ключ API | securestring | Ключ API для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Отправка MMS |
Отправка MMS |
| Отправка SMS |
Каждый 160 символов = 1 SMS. Может отправлять до 1224 стандартных символов. |
| Отправка голосового сообщения |
Каждый 300 символов = 1 голосовое сообщение. Может отправлять до 1200 стандартных символов |
| Отправка открытки |
Отправка одной или нескольких открытки |
| Отправка письма |
Отправка письма |
| Отправка факса |
Отправка факса |
| Получение контактов в списке |
Получение всех контактов в списке |
| Получение списков контактов |
Получение всех списков контактов, если не указано в предварительных параметрах |
| Преобразование формата файла мультимедиа |
Преобразование формата файла мультимедиа |
| Создание нового контакта |
Создание нового контакта |
| Создание списка контактов |
Создание списка контактов |
| Списки контактов поиска |
Получение списка контактов с поиском |
| Удаление контакта |
Удаление контакта |
| Удаление списка |
Удаление определенного списка контактов |
Отправка MMS
Отправка MMS
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Кому
|
to | True | string |
Номер мобильного телефона. Может быть в локальном или международном формате. Должен быть в международном формате (E.164) при отправке в другую страну. Например, +61411111111. |
|
субъект
|
subject | True | string |
Строка темы. Максимум 20 символов. |
|
сообщение
|
body | True | string |
Текст сообщения. До 1500 символов или 500 символов Юникода |
|
Настраиваемая строка
|
custom_string | string |
Это ваша ссылка. Он будет отображаться во всех отчетах и будет передан обратно с любыми ответами. |
|
|
URL-адрес мультимедиа
|
media_file | True | string |
Поддерживает максимальный размер файла размером 250 кб, GIF может поддерживаться только в том случае, если размер файла ниже 100 кб |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Общая цена
|
data.total_price | float |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
messages
|
data.messages | array of object |
Msg |
|
Идентификатор списка
|
data.messages.list_id | integer |
Идентификатор списка |
|
Код контактного лица
|
data.messages.contact_id | integer |
Код контактного лица |
|
Идентификатор сообщения
|
data.messages.message_id | string |
Идентификатор сообщения |
|
Кому
|
data.messages.to | string |
Кому |
|
Тема
|
data.messages.subject | string |
Тема |
|
От
|
data.messages.from | string |
От |
|
Тело
|
data.messages.body | string |
Тело |
|
Страна
|
data.messages.country | string |
Страна |
|
Настраиваемая строка
|
data.messages.custom_string | string |
Настраиваемая строка |
|
Части сообщения
|
data.messages.message_parts | integer |
Части сообщения |
|
Цена сообщения
|
data.messages.message_price | string |
Цена сообщения |
|
URL-адрес файла мультимедиа
|
data.messages._media_file_url | string |
URL-адрес файла мультимедиа |
|
Состояние
|
data.messages.status | string |
Состояние |
Отправка SMS
Каждый 160 символов = 1 SMS. Может отправлять до 1224 стандартных символов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Кому
|
to | True | string |
Номер мобильного телефона. Может быть в локальном или международном формате. Должен быть в международном формате (E.164) при отправке в другую страну. Например, +61411111111. |
|
Тело
|
body | True | string |
160 символов — 1 SMS. Может отправлять до 1224 стандартных символов. |
|
Настраиваемая строка
|
custom_string | string |
Это ваша ссылка. Он будет отображаться во всех отчетах и будет передан обратно с любыми ответами. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Msg ответа
|
response_msg | string |
Msg ответа |
|
Общая цена
|
data.total_price | float |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
messages
|
data.messages | array of object |
Message |
|
Направление
|
data.messages.direction | string |
Направление |
|
Date
|
data.messages.date | integer |
Date |
|
Кому
|
data.messages.to | string |
Кому |
|
Тело
|
data.messages.body | string |
Тело |
|
От
|
data.messages.from | string |
От |
|
Идентификатор сообщения
|
data.messages.message_id | string |
Идентификатор сообщения |
|
Части сообщения
|
data.messages.message_parts | integer |
Части сообщения |
|
Цена сообщения
|
data.messages.message_price | string |
Цена сообщения |
|
Из электронной почты
|
data.messages.from_email | string |
Из электронной почты |
|
Идентификатор списка
|
data.messages.list_id | string |
Идентификатор списка |
|
Настраиваемая строка
|
data.messages.custom_string | string |
Настраиваемая строка |
|
Контактный номер
|
data.messages.contact_id | string |
Контактный номер |
|
Идентификатор пользователя
|
data.messages.user_id | integer |
Идентификатор пользователя |
|
Идентификатор подсчета
|
data.messages.subaccount_id | integer |
Идентификатор подсчета |
|
Страна
|
data.messages.country | string |
Страна |
|
Носитель
|
data.messages.carrier | string |
Носитель |
|
Состояние
|
data.messages.status | string |
Состояние |
|
Короткое название валюты
|
data._currency.currency_name_short | string |
Короткое название валюты |
|
Префикс валюты D
|
data._currency.currency_prefix_d | string |
Префикс валюты D |
|
Префикс валюты C
|
data._currency.currency_prefix_c | string |
Префикс валюты C |
|
Имя валюты long
|
data._currency.currency_name_long | string |
Имя валюты long |
Отправка голосового сообщения
Каждый 300 символов = 1 голосовое сообщение. Может отправлять до 1200 стандартных символов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Кому
|
to | True | string |
Мобильный или стационарный номер телефона в местном или международном формате. Должен быть в международном формате (E.164) при отправке в другую страну, например. +61411111111. |
|
Тело
|
body | True | string |
Текст сообщения для чтения. |
|
Language
|
lang | True | string |
Выберите язык, который вы хотите использовать. |
|
Голос
|
voice | True | string |
Выберите сообщение, которое будет прочитано в мужском голосе женщины. |
|
Настраиваемая строка
|
custom_string | string |
Это ваша ссылка. Он будет отображаться во всех отчетах и будет передан обратно с любыми ответами. |
|
|
Требовать входные данные
|
require_input | integer |
Получение ключа от получателя. Значение флага должно быть равно 1 для да или 0. |
|
|
Обнаружение компьютеров
|
machine_detection | integer |
Определите компьютер или голосовую почту и оставьте сообщение. Значение флага должно быть равно 1 для да или 0. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Общая цена
|
data.total_price | float |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
messages
|
data.messages | array of object |
messages |
|
Идентификатор пользователя
|
data.messages.user_id | integer |
Идентификатор пользователя |
|
Идентификатор подсчетной записи
|
data.messages.subaccount_id | integer |
Идентификатор подсчетной записи |
|
Идентификатор сообщения
|
data.messages.message_id | string |
Идентификатор сообщения |
|
Кому
|
data.messages.to | string |
Кому |
|
Тип
|
data.messages.to_type | string |
Тип |
|
От
|
data.messages.from | string |
От |
|
Голос
|
data.messages.voice | string |
Голос |
|
Language
|
data.messages.lang | string |
Language |
|
Тело
|
data.messages.body | string |
Bddy |
|
Носитель
|
data.messages.carrier | string |
Носитель |
|
Страна
|
data.messages.country | string |
Страна |
|
Настраиваемая строка
|
data.messages.custom_string | string |
Настраиваемая строка |
|
Расписание
|
data.messages.schedule | integer |
Расписание |
|
Части сообщения
|
data.messages.message_parts | integer |
Части сообщения |
|
Цена сообщения
|
data.messages.message_price | string |
Цена сообщения |
|
Добавлено
|
data.messages.date_added | integer |
Добавлено |
|
Требовать входные данные
|
data.messages.require_input | integer |
Требовать входные данные |
|
Обнаружение компьютеров
|
data.messages.machine_detection | integer |
Обнаружение компьютеров |
|
Состояние
|
data.messages.status | string |
Состояние |
|
Короткое название валюты
|
data._currency.currency_name_short | string |
Короткое название валюты |
|
Префикс валюты D
|
data._currency.currency_prefix_d | string |
Префикс валюты D |
|
Префикс валюты C
|
data._currency.currency_prefix_c | string |
Префикс валюты C |
|
Имя валюты long
|
data._currency.currency_name_long | string |
Имя валюты long |
Отправка открытки
Отправка одной или нескольких открытки
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя
|
address_name | True | string |
Имя адреса |
|
Город
|
address_city | True | string |
Город |
|
Государство
|
address_state | True | string |
Государство |
|
Почтовый индекс
|
address_postal_code | True | string |
Почтовый индекс |
|
Страна
|
address_country | True | string |
Страна |
|
Идентификатор возвращаемого адреса
|
return_address_id | True | integer |
Возврат идентификатора адреса для использования |
|
Адресная строка 1
|
address_line_1 | True | string |
Первая строка адреса |
|
Строка адреса 2
|
address_line_2 | string |
Вторая строка адреса |
|
|
file_urls
|
file_urls | True | array of string |
URL-адрес PDF-файла |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Общая цена
|
data.total_price | double |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
recipients
|
data.recipients | array of object |
Recipient |
|
Идентификатор пользователя
|
data.recipients.user_id | integer |
Идентификатор пользователя |
|
Идентификатор подсчетной записи
|
data.recipients.subaccount_id | integer |
Идентификатор подсчетной записи |
|
Идентификатор сообщения
|
data.recipients.message_id | string |
Идентификатор сообщения |
|
Имя адреса
|
data.recipients.address_name | string |
Имя адреса |
|
Адресная строка 1
|
data.recipients.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.recipients.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.recipients.address_city | string |
Адрес города |
|
Состояние адреса
|
data.recipients.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.recipients.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.recipients.address_country | string |
Адресная страна |
|
Идентификатор возвращаемого адреса
|
data.recipients.return_address_id | integer |
Идентификатор возвращаемого адреса |
|
Расписание
|
data.recipients.schedule | integer |
Расписание |
|
Цена после публикации
|
data.recipients.post_price | string |
Цена после публикации |
|
Состояние
|
data.recipients.status | string |
Состояние |
|
Добавлено
|
data.recipients.date_added | integer |
Добавлено |
|
URL-адрес файла
|
data.recipients._file_url | string |
URL-адрес файла |
|
Идентификатор возвращаемого адреса
|
data.recipients._return_address.return_address_id | integer |
Идентификатор возвращаемого адреса |
|
Идентификатор пользователя
|
data.recipients._return_address.user_id | integer |
Идентификатор пользователя |
|
Имя адреса
|
data.recipients._return_address.address_name | string |
Имя адреса |
|
Адресная строка 1
|
data.recipients._return_address.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.recipients._return_address.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.recipients._return_address.address_city | string |
Адрес города |
|
Состояние адреса
|
data.recipients._return_address.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.recipients._return_address.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.recipients._return_address.address_country | string |
Адресная страна |
|
Имя пользователя API
|
data.recipients._api_username | string |
Имя пользователя API |
|
Короткое название валюты
|
data._currency.currency_name_short | string |
Короткое название валюты |
|
Префикс валюты D
|
data._currency.currency_prefix_d | string |
Префикс валюты D |
|
Префикс валюты C
|
data._currency.currency_prefix_c | string |
Префикс валюты C |
|
Имя валюты long
|
data._currency.currency_name_long | string |
Имя валюты long |
Отправка письма
Отправка письма
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
URL-адрес PDF-файла
|
file_url | True | string |
Максимальный размер файла составляет 10 МБ. Все страницы должны находиться на портрете. Чат с поддержкой ClickSend для полных спецификаций. |
|
Используемый шаблон
|
template_used | integer |
Указывает, используется ли шаблон буквы. Значение флага должно быть равно 1 для да или 0. |
|
|
Цвет
|
colour | True | integer |
Выберите использование цвета или печати B&W. (Черный и белый = 0, цвет = 1) |
|
Duplex
|
duplex | True | integer |
Выберите использовать Duplex = 1 (двойной) или Simplex = 0(односторонняя) печать. |
|
Приоритет post
|
priority_post | integer |
Если буква является приоритетом, значение флага должно быть равно 1 для да или 0 для отсутствия. |
|
|
Имя
|
address_name | True | string |
Имя адреса |
|
Город
|
address_city | True | string |
Город |
|
Государство
|
address_state | True | string |
Государство |
|
Почтовый индекс
|
address_postal_code | True | string |
Почтовый индекс |
|
Страна
|
address_country | True | string |
Страна |
|
Выбор возвращаемого адреса
|
return_address_id | True | integer |
Возврат идентификатора адреса для использования |
|
Адресная строка 1
|
address_line_1 | True | string |
Первая строка адреса |
|
Строка адреса 2
|
address_line_2 | string |
Вторая строка адреса |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Общая цена
|
data.total_price | float |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
recipients
|
data.recipients | array of object |
item |
|
Идентификатор пользователя
|
data.recipients.user_id | integer |
Идентификатор пользователя |
|
Идентификатор подсчетной записи
|
data.recipients.subaccount_id | integer |
Идентификатор подсчетной записи |
|
Идентификатор сообщения
|
data.recipients.message_id | string |
Идентификатор сообщения |
|
Имя адреса
|
data.recipients.address_name | string |
Имя адреса |
|
Адресная строка 1
|
data.recipients.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.recipients.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.recipients.address_city | string |
Адрес города |
|
Состояние адреса
|
data.recipients.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.recipients.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.recipients.address_country | string |
Адресная страна |
|
Идентификатор возвращаемого адреса
|
data.recipients.return_address_id | integer |
Идентификатор возвращаемого адреса |
|
Настраиваемая строка
|
data.recipients.custom_string | string |
Настраиваемая строка |
|
Исходный материал
|
data.recipients.source | string |
Исходный материал |
|
Цвет
|
data.recipients.colour | integer |
Цвет |
|
Duplex
|
data.recipients.duplex | integer |
Duplex |
|
Страницы публикации
|
data.recipients.post_pages | integer |
Страницы публикации |
|
Цена после публикации
|
data.recipients.post_price | string |
Цена после публикации |
|
Приоритет post
|
data.recipients.priority_post | integer |
Приоритет post |
|
Добавлено
|
data.recipients.date_added | integer |
Добавлено |
|
Состояние
|
data.recipients.status | string |
Состояние |
|
URL-адрес файла
|
data.recipients._file_url | string |
URL-адрес файла |
|
Идентификатор возвращаемого адреса
|
data.recipients._return_address.return_address_id | integer |
Идентификатор возвращаемого адреса |
|
Идентификатор пользователя
|
data.recipients._return_address.user_id | integer |
Идентификатор пользователя |
|
Имя адреса
|
data.recipients._return_address.address_name | string |
Имя адреса |
|
Адресная строка 1
|
data.recipients._return_address.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.recipients._return_address.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.recipients._return_address.address_city | string |
Адрес города |
|
Состояние адреса
|
data.recipients._return_address.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.recipients._return_address.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.recipients._return_address.address_country | string |
Адресная страна |
|
Имя пользователя API
|
data.recipients._api_username | string |
Имя пользователя API |
|
Короткое название валюты
|
data._currency.currency_name_short | string |
Короткое название валюты |
|
Префикс валюты D
|
data._currency.currency_prefix_d | string |
Префикс валюты D |
|
Префикс валюты C
|
data._currency.currency_prefix_c | string |
Префикс валюты C |
|
Имя валюты long
|
data._currency.currency_name_long | string |
Имя валюты long |
Отправка факса
Отправка факса
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Кому
|
to | True | string |
Номер телефона в формате E.164. Eg. +61261111111. |
|
Настраиваемая строка
|
custom_string | string |
Это ваша ссылка. Он будет отображаться во всех отчетах и будет передан обратно с любыми ответами. |
|
|
URL-адрес PDF-файла
|
file_url | True | string |
Максимальный размер файла составляет 4 МБ. Все страницы должны находиться на портрете. Чат с поддержкой ClickSend для полных спецификаций |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Общая цена
|
data.total_price | float |
Общая цена |
|
Общее число
|
data.total_count | integer |
Общее число |
|
Количество очередей
|
data.queued_count | integer |
Количество очередей |
|
messages
|
data.messages | array of object |
messages |
|
Идентификатор пользователя
|
data.messages.user_id | integer |
Идентификатор пользователя |
|
Идентификатор подсчетной записи
|
data.messages.subaccount_id | integer |
Идентификатор подсчетной записи |
|
Идентификатор списка
|
data.messages.list_id | string |
Идентификатор списка |
|
Идентификатор сообщения
|
data.messages.message_id | string |
Идентификатор сообщения |
|
Кому
|
data.messages.to | string |
Кому |
|
От
|
data.messages.from | string |
От |
|
Носитель
|
data.messages.carrier | string |
Носитель |
|
Страна
|
data.messages.country | string |
Страна |
|
Настраиваемая строка
|
data.messages.custom_string | string |
Настраиваемая строка |
|
Страницы сообщений
|
data.messages.message_pages | integer |
Страницы сообщений |
|
Цена сообщения
|
data.messages.message_price | string |
Цена сообщения |
|
Код состояния
|
data.messages.status_code | string |
Код состояния |
|
Текст состояния
|
data.messages.status_text | string |
Текст состояния |
|
Добавлено
|
data.messages.date_added | integer |
Добавлено |
|
Из электронной почты
|
data.messages.from_email | string |
Из электронной почты |
|
URL-адрес файла
|
data.messages._file_url | string |
URL-адрес файла |
|
Состояние
|
data.messages.status | string |
Состояние |
|
Короткое название валюты
|
data._currency.currency_name_short | string |
Короткое название валюты |
|
Префикс валюты D
|
data._currency.currency_prefix_d | string |
Префикс валюты D |
|
Префикс валюты C
|
data._currency.currency_prefix_c | string |
Префикс валюты C |
|
Имя валюты long
|
data._currency.currency_name_long | string |
Имя валюты long |
Получение контактов в списке
Получение всех контактов в списке
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | integer |
Для получения идентификатора списка контактов можно использовать действие "Поиск контактов" или "Получить список контактов" |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Total
|
data.total | integer |
Total |
|
На страницу
|
data.per_page | integer |
На страницу |
|
Текущая страница
|
data.current_page | integer |
Текущая страница |
|
Последняя страница
|
data.last_page | integer |
Последняя страница |
|
Url-адрес следующей страницы
|
data.next_page_url | string |
Url-адрес следующей страницы |
|
URL-адрес страницы предварительной версии
|
data.prev_page_url | string |
URL-адрес страницы предварительной версии |
|
От
|
data.from | integer |
От |
|
Кому
|
data.to | integer |
Кому |
|
данные
|
data.data | array of object |
данные |
|
Код контактного лица
|
data.data.contact_id | integer |
Код контактного лица |
|
Идентификатор списка
|
data.data.list_id | integer |
Идентификатор списка |
|
Номер телефона
|
data.data.phone_number | string |
Номер телефона |
|
Имя (Первое имя)
|
data.data.first_name | string |
Имя (Первое имя) |
|
Фамилия
|
data.data.last_name | string |
Фамилия |
|
Пользовательский 1
|
data.data.custom_1 | string |
Пользовательский 1 |
|
Пользовательский 2
|
data.data.custom_2 | string |
Пользовательский 2 |
|
Пользовательский 3
|
data.data.custom_3 | string |
Пользовательский 3 |
|
Пользовательский 4
|
data.data.custom_4 | string |
Пользовательский 4 |
|
date_added
|
data.data.date_added | integer |
Добавлено |
|
Дата обновления
|
data.data.date_updated | integer |
Дата обновления |
|
номер факса;
|
data.data.fax_number | string |
номер факса; |
|
Название организации
|
data.data.organization_name | string |
Название организации |
|
Адрес электронной почты
|
data.data.email | string |
Адрес электронной почты |
|
Адресная строка 1
|
data.data.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.data.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.data.address_city | string |
Адрес города |
|
Состояние адреса
|
data.data.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.data.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.data.address_country | string |
Адресная страна |
|
Имя списка
|
data.data._list_name | string |
Имя списка |
Получение списков контактов
Получение всех списков контактов, если не указано в предварительных параметрах
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
page | integer |
Номер страницы |
|
|
Количество записей на страницу
|
limit | integer |
Количество записей на страницу |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Total
|
data.total | integer |
Total |
|
На страницу
|
data.per_page | integer |
На страницу |
|
Текущая страница
|
data.current_page | integer |
Текущая страница |
|
Последняя страница
|
data.last_page | integer |
Последняя страница |
|
Url-адрес следующей страницы
|
data.next_page_url | string |
Url-адрес следующей страницы |
|
URL-адрес страницы предварительной версии
|
data.prev_page_url | string |
URL-адрес страницы предварительной версии |
|
От
|
data.from | integer |
От |
|
Кому
|
data.to | integer |
Кому |
|
данные
|
data.data | array of object |
данные |
|
Идентификатор списка
|
data.data.list_id | integer |
Идентификатор списка |
|
Имя списка
|
data.data.list_name | string |
Имя списка |
|
Список идентификаторов электронной почты
|
data.data.list_email_id | string |
Список идентификаторов электронной почты |
|
Число контактов
|
data.data._contacts_count | integer |
Число контактов |
|
Импорт инпрогрессов
|
data.data._import_in_progress | integer |
Импорт инпрогрессов |
|
OptOut Inprogress
|
data.data._optout_in_progress | integer |
OptOut Inprogress |
Преобразование формата файла мультимедиа
Преобразование формата файла мультимедиа
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор действия, в который требуется файл
|
convert | True | string |
Выбор действия, в который требуется файл |
|
Файл
|
content | True | byte |
Содержимое файла (base64) |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Идентификатор отправки
|
data.upload_id | integer |
Идентификатор отправки |
|
Имя файла
|
data.file_name | string |
Имя файла |
|
Добавлено
|
data.date_added | integer |
Добавлено |
|
Дата удаления
|
data.date_delete | integer |
Дата удаления |
|
Идентификатор пользователя
|
data.user_id | integer |
Идентификатор пользователя |
|
URL-адрес
|
data._url | string |
URL-адрес |
Создание нового контакта
Создание нового контакта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | integer |
Для получения идентификатора списка контактов можно использовать действие "Поиск контактов" или "Получить список контактов" |
|
Имя (Первое имя)
|
first_name | True | string |
Имя контакта. |
|
Фамилия
|
last_name | True | string |
Фамилия контакта. |
|
Номер телефона
|
phone_number | True | string |
Контактный телефон в локальном или международном формате, например +61411111111. |
|
Адрес электронной почты
|
string |
Адрес электронной почты контакта. |
||
|
номер факса;
|
fax_number | string |
Номер факса контакта. |
|
|
Название организации
|
organization_name | string |
Имя организации контакта. |
|
|
Страна
|
address_country | string |
Страна контакта. |
|
|
Государство
|
address_state | string |
Государство |
|
|
Город
|
address_city | string |
Адрес города |
|
|
Пользовательский 1
|
custom_1 | string |
Пользовательский 1 |
|
|
Пользовательский 3
|
custom_3 | string |
Пользовательский 3 |
|
|
Почтовый индекс
|
address_postal_code | string | ||
|
Пользовательский 2
|
custom_2 | string |
Пользовательский 2 |
|
|
Пользовательский 4
|
custom_4 | string |
Пользовательский 4 |
|
|
Адресная строка 1
|
address_line_1 | string |
Адресная строка 1 |
|
|
Строка адреса 2
|
address_line_2 | string |
Строка адреса 2 |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Код контактного лица
|
data.contact_id | integer |
Код контактного лица |
|
Идентификатор списка
|
data.list_id | integer |
Идентификатор списка |
|
Номер телефона
|
data.phone_number | string |
Номер телефона |
|
Имя (Первое имя)
|
data.first_name | string |
Имя (Первое имя) |
|
Фамилия
|
data.last_name | string |
Фамилия |
|
Пользовательский 1
|
data.custom_1 | string |
Пользовательский 1 |
|
Пользовательский 2
|
data.custom_2 | string |
Пользовательский 2 |
|
Пользовательский 3
|
data.custom_3 | string |
Пользовательский 3 |
|
Пользовательский 4
|
data.custom_4 | string |
Пользовательский 4 |
|
Добавлено
|
data.date_added | integer |
Добавлено |
|
номер факса;
|
data.fax_number | string |
номер факса; |
|
Название организации
|
data.organization_name | string |
Название организации |
|
Адрес электронной почты
|
data.email | string |
Адрес электронной почты |
|
Адресная строка 1
|
data.address_line_1 | string |
Адресная строка 1 |
|
Строка адреса 2
|
data.address_line_2 | string |
Строка адреса 2 |
|
Адрес города
|
data.address_city | string |
Адрес города |
|
Состояние адреса
|
data.address_state | string |
Состояние адреса |
|
Почтовый индекс адреса
|
data.address_postal_code | string |
Почтовый индекс адреса |
|
Адресная страна
|
data.address_country | string |
Адресная страна |
|
Имя списка
|
data._list_name | string |
Имя списка |
Создание списка контактов
Создание списка контактов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя списка
|
list_name | True | string |
Имя списка контактов |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Идентификатор списка
|
data.list_id | integer |
Идентификатор списка |
|
Имя списка
|
data.list_name | string |
Имя списка |
|
Список идентификаторов электронной почты
|
data.list_email_id | string |
Список идентификаторов электронной почты |
|
Число контактов
|
data._contacts_count | integer |
Число контактов |
Списки контактов поиска
Получение списка контактов с поиском
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя списка
|
q | True | string |
Искать |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
|
Total
|
data.total | integer |
Total |
|
На страницу
|
data.per_page | integer |
На страницу |
|
Текущая страница
|
data.current_page | integer |
Текущая страница |
|
Последняя страница
|
data.last_page | integer |
Последняя страница |
|
Url-адрес следующей страницы
|
data.next_page_url | string |
Url-адрес следующей страницы |
|
URL-адрес страницы предварительной версии
|
data.prev_page_url | string |
URL-адрес страницы предварительной версии |
|
От
|
data.from | integer |
От |
|
Кому
|
data.to | integer |
Кому |
|
данные
|
data.data | array of object |
данные |
|
Идентификатор
|
data.data.id | integer |
Идентификатор |
|
Имя
|
data.data.name | string |
Имя |
|
Контакт
|
data.data.contact | string |
Контакт |
|
Тип
|
data.data.type | string |
Тип |
|
Число контактов
|
data.data.contacts_count | integer |
Число контактов |
Удаление контакта
Удаление контакта
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | integer |
Для получения идентификатора списка контактов можно использовать действие "Поиск контактов" или "Получить список контактов" |
|
Код контактного лица
|
contact_id | True | integer |
Код контактного лица |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
Удаление списка
Удаление определенного списка контактов
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор списка
|
list_id | True | integer |
Для получения идентификатора списка контактов можно использовать действие "Поиск контактов" или "Получить список контактов" |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Http Code
|
http_code | integer |
Http Code |
|
Код ответа
|
response_code | string |
Код ответа |
|
Ответное сообщение
|
response_msg | string |
Ответное сообщение |
Триггеры
| Автоматизация входящих сообщений SMS |
Создание входящего SMS-автоматизации |
Автоматизация входящих сообщений SMS
Создание входящего SMS-автоматизации
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тело
|
body | string |
body |
|
Кому
|
to | string |
Номер телефона получателя |
|
От
|
from | string |
Идентификатор отправителя |
|
Настраиваемая строка
|
custom_string | string |
custom_string |
|
Исходный идентификатор сообщения
|
original_message_id | string |
original_message_id |
|
Исходный текст
|
original_body | string |
Исходный текст |
|
Идентификатор пользователя
|
user_id | integer |
Идентификатор пользователя, отправившего сообщение. |
|
Идентификатор подсчета
|
subaccount_id | integer |
Идентификатор подсчета пользователя, отправившего сообщение. |
|
Отметка времени
|
timestamp | integer |
Метка времени в формате UNIX |
|
Идентификатор сообщения
|
message_id | string |
Идентификатор сообщения для входящего сообщения |