Работа с контактами

Создание контакта пользователя

URL запроса:
POST https://api.catapulto.ru/api/v1/users/contact/create/

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

Поле Тип Обязательное Описание
address_line_1 String Нет Строка адреса 1
address_line_2 String Нет Строка адреса 2
locality_id String Нет ID геообъекта
(из метода получения информации о городе)
zip String Да Почтовый индекс
(из метода получения информации о городе)
street String Нет Улица
street_type String Нет Тип улицы
building String Нет Здание
door_number String Нет Офис/квартира
comment String Нет Комментарий
company String Нет Компания
name String Нет Имя Фамилия
phone String Нет Телефон
is_favorite String Нет В избранном
iso String Нет Код страны

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

POST /api/v1/users/contact/create/ HTTP/1.1
Host: https://api.catapulto.ru
X-Token: "6c523bd79898gd706c32a05aff13003dc07737e0"
Content-Type: application/json

{
  "address_line_1": "ул Строителей",
  "address_line_2": "",
  "locality_id": "3611199",
  "zip": "103070",
  "building": "15",
  "comment": "Новый клиент Catapulto, офис 12",
  "company": "Catapulto",
  "iso": "RU",
  "name": "Вася Пупкин",
  "phone": "+7 (495) 555-22-41",
  "street": "ул Строителей",
}

Содержание ответа

Поле Тип Описание
id Integer
locality
id
Integer
iso
String
region1
String
region1_type
String
region2
String
region2_type
String
region3
String
region3_type
String
locality
String
aoid
String
slug
String
zip String
street String
street_type String
building String
door_number String
comment String
company String
name String
phone String
usergroup
id
Integer
title
String
address_line_1 String
address_line_2 String

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

{
  "id": 2088703, 
  "locality": { 
    "id": 3611199, 
    "iso": "RU", 
    "region1": "Москва", 
    "region1_type": "г", 
    "region2": "", 
    "region2_type": "", 
    "region3": "", 
    "region3_type": "", 
    "locality": "Москва", 
    "aoid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", 
    "slug": "moskva"
  }, 
  "zip": "103070", 
  "street": "ул Строителей", 
  "street_type": "", 
  "building": "15", 
  "door_number": "", 
  "comment": "Новый клиент Catapulto, офис 12", 
  "company": "Catapulto", 
  "name": "Вася Пупкин", 
  "phone": "+74955552241", 
  "usergroup": { 
    "id": 31810, 
    "title": "Основной отдел"
  }, 
  "address_line_1": "ул Строителей", 
  "address_line_2": ""
}

Редактирование существующего контакта пользователя

URL запроса:
POST https://api.catapulto.ru/api/v1/users/contact/update/

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

Поле Тип Обязательное Описание
id String Нет ? Идентификатор контакта
address_line_1 String Нет Строка адреса 1
address_line_2 String Нет Строка адреса 2
locality_id String Нет ID геообъекта
(из метода получения информации о городе)
zip String Да Почтовый индекс
(из метода получения информации о городе)
street String Нет Улица
street_type String Нет Тип улицы
building String Нет Здание
door_number String Нет Офис/квартира
comment String Нет Комментарий
company String Нет Компания
name String Нет Имя Фамилия
phone String Нет Телефон
is_favorite String Нет В избранном
iso String Нет Код страны

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

POST /api/v1/users/contact/update/ HTTP/1.1
Host: https://api.catapulto.ru
X-Token: "6c523bd79898gd706c32a05aff13003dc07737e0"
Content-Type: application/json

{
  "address_line_1": "ул Строителей",
  "address_line_2": "",
  "locality_id": "3611199",
  "zip": "103070",
  "building": "15",
  "comment": "Новый клиент Catapulto, офис 12",
  "company": "Catapulto",
  "iso": "RU",
  "name": "Вася Пупкин",
  "phone": "+7 (495) 555-22-41",
  "street": "ул Строителей",
}

Получение списка контактов пользователя:

URL запроса:
GET https://api.catapulto.ru/api/v1/users/contact/list/

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

Поле Тип Обязательное Описание
limit String Нет

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

GET /api/v1/users/contact/list?limit=25 HTTP/1.1
Host: https://api.catapulto.ru
X-Token: "6c523bd79898gd706c32a05aff13003dc07737e0"
Accept: application/json

Содержание ответа

Поле Тип Описание
count Integer
next String
previous Integer or Null
results List
id
Integer
locality
id
Integer
iso
String
region1
String
region1_type
String
region2
String
region2_type
String
region3
String
region3_type
String
locality
String
aoid
String
slug
String
utc_offset
Integer
zip
String
street
String
street_type
String
building
String
door_number
String
comment
String
company
String
name
String
phone
String
usergroup
id
Integer
title
String
is_favorite
Boolean
show_in_book
Boolean
address_line_1
String
address_line_2
String
has_permissions
Boolean
latitude
Float
longitude
Float
phone2
String
phone_extension
String
phone2_extension
String
inn
String
kpp
String
country
String
is_valid_contact
Boolean

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

{
  "count": 1, 
  "next": "http://api.catapulto.ru/api/v1/users/contact/list/?limit=25", 
  "previous": null, 
  "results": [
    {
      "id": 11970944, 
      "locality": {
        "id": 3615178, 
        "iso": "RU", 
        "region1": "Орловская", 
        "region1_type": "обл", 
        "region2": "", 
        "region2_type": "", 
        "region3": "", 
        "region3_type": "", 
        "locality": "Орел", 
        "aoid": "2abed4d9-5565-4885-bc96-f4ffccc6cba4", 
        "slug": "orel", 
        "utc_offset": 3
      }, 
      "zip": "302042", 
      "street": "Тест", 
      "street_type": "ш", 
      "building": "4", 
      "door_number": "", 
      "comment": "", 
      "company": "Тестовая компания", 
      "name": "Менеджер тестовой компании", 
      "phone": "+74955445000", 
      "usergroup": { 
        "id": 43434, 
        "title": "Тестовый отдел"
      }, 
      "is_favorite": false, 
      "show_in_book": true, 
      "address_line_1": "302042, Орловская обл, Орел, Кромское ш, 4",
      "address_line_2": "", 
      "has_permissions": true, 
      "latitude": 52.9216, 
      "longitude": 36.01045, 
      "phone2": "", 
      "phone_extension": null, 
      "phone2_extension": null, 
      "inn": "", 
      "kpp": null, 
      "country": "RU", 
      "is_valid_contact": true
    }
  ]
}

Получение информации о городе

Request URL:
GET https://api.catapulto.ru/api/v1/geo/locality/search/

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

Поле Тип Обязательное Описание
term String Да Поисковый запрос
iso String Да Код страны
limit Integer Нет Ограничение выборки
(максимум 50)

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

GET /api/v1/geo/locality/search?term=Москва&iso=RU HTTP/1.1
Host: https://api.catapulto.ru
Accept: application/json

Содержание ответа

Поле Тип Описание
id Integer ID
region1 String Регион 1
region1_type String Тип региона 1
region2 String Регион 2
region3 String Регион 3
locality String Название
zip String Почтовый индекс
aoid String ФИАС
shortname String Сокращение
slug String ЧПУ
utc_offset String часовой пояс от UTC
iso String код страны

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

[
  {
    "id": "3611199", 
    "region1": null,
    "region1_type": "г", 
    "region2": "", 
    "region2_type": "", 
    "region3": "", 
    "locality": "Москва", 
    "zip": "103070", 
    "aoid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5", 
    "shortname": "г", 
    "slug": "moskva", 
    "utc_offset": "3", 
    "iso": null
  },
  {
    ...
  }
]
Предыдущая статья:
Catapulto API
Следующая статья:
Создание отправления