URL запроса
POST https://app.sms.by/api/v2/importContacts
За один вызов можно импортировать не более 500 контактов и количество пользовательских полей не должно превышать 30. В пользовательских полях обязательно должно присутствовать phone или email.
Если в списке уже есть контакт с передаваемым номером телефона или email-адресом, такой контакт не будет добавлен повторно, но обновятся его параметры, которые переданы в field_names.
Для примера добавим в список рассылки 2 контакта с пользовательскими полями phone, email и name. Запрос будет выглядеть так:
https://app.sms.by/api/v2/importContacts?token=***&list_id=123&field_names[0]=phone&field_names[1]=email&field_names[2]=name&data[0][0]=375291111111&data[0][1]=email1@example.by&data[0][2]=Алексей&data[1][0]=375291111112&data[1][1]=email2@example.by&data[1][2]=Ирина
В ответе в поле result метод возвратит массив со следующими данными:
inserted - сколько новых контактов было добавлено в список,
updated - сколько контактов было изменено,
invalid - сколько контактов не было импортировано,
log - ошибки и предупреждения импорта. Если количество invalid больше 0, будет содержать массив со следующими данными: index - номер контакта в массиве data, error_message - описание ошибки.
Параметры
| Параметр |
Расположение |
Тип |
Обязательный |
Описание |
| token |
query |
string |
Да |
Ваш API ключ |
| list_id |
query |
integer |
Да |
ID списка рассылки |
| field_names[0] |
query |
string |
Да |
Название первого пользовательского поля |
| field_names[1] |
query |
string |
Нет |
Название второго пользовательского поля |
| field_names[2] |
query |
string |
Нет |
Название третьего пользовательского поля |
| data[0][0] |
query |
string |
Да |
Первый параметр для первого контакта |
| data[0][1] |
query |
string |
Нет |
Второй параметр для первого контакта |
| data[0][2] |
query |
string |
Нет |
Третий параметр для первого контакта |
| data[1][0] |
query |
string |
Нет |
Первый параметр для второго контакта |
| data[1][1] |
query |
string |
Нет |
Второй параметр для второго контакта |
| data[1][2] |
query |
string |
Нет |
Третий параметр для второго контакта |
Ответы
200 — Выполнено успешно
{
"status": "OK",
"result": {
"inserted": 10,
"updated": 5,
"invalid": 1,
"log": [
{
"index": 13,
"error_message": "Некорректный номер телефона"
}
]
}
}