Контакты

Список контактов

GET /domains/{domain_id}/contacts/

Дополнительные GET-параметры

  • ?search=<querystring> – поиск по полям email, first_name, last_name, middle_name
  • ?status_not=<querystring> - исключение из выборки контактов с определенным статусом

Ответ

HTTP 200 OK

{
  "paging": {...},
  "data": [
    {
      "id": 321,
      "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
      "email": "alex@test.com",
      "first_name": "Алексей",
      "last_name": "Пупкин",
      "middle_name": "Витальевич",
      "emails": [
        "a.pupkin@corp.test.com",
        "a.pupkin@gmail.com"
      ]
      "phones": [
        {
          "phone": "+79123456789",
          "type": "work"
        }
      ]
    }
  ]
}

Список контактов разбивается на страницы. Механизм постраничной навигации описан в разделе Постраничная навигация.

Описание полей

Название С Ф Тип Описание
sid
String Идентификатор контакта
status
String Статус контакта
email
String Email контакта
first_name  
String Имя контакта
last_name  
String Фамилия контакта
middle_name     String Отчество контакта
company  
String Компания контакта
boss  
String Начальник контакта
department  
String Отдел/подразделение контакта
position  
String Должность контакта
office  
String Офис контакта
address  
String Адрес контакта
сomment  
String Примечание
emails     Array Список дополнительных email-адресов контакта
phones     Array Список словарей с информацией о телефонных номерах контакта.

Добавление контакта

POST /domains/{domain_id}/contacts/

Поля

sid: optional: string
Идентификатор (если не указан, будет выдан автоматически)
email: required: string
Email контакта
first_name: optional: string
Имя контакта
last_name: optional: string
Фамилия контакта
middle_name: optional: string
Отчество контакта
company: optional: string
Компания контакта
boss: optional: string
Начальник контакта
department: optional: string
Отдел/подразделение контакта
position: optional: string
Должность контакта
office: optional: string
Офис контакта
address: optional: string
Адрес контакта
comment: optional: string
Комментарий к контакту
emails: optional: array
Дополнительные email-адреса контакта
phones: optional: array
Телефонные номера контакта
phones type: optional: string
Тип телефона. Разрешенные значения: mobile, home, work, fax, other
{
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин"
}

Ответ

HTTP 201 CREATED

{
  "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин"
}

Редактирование контакта

PATCH /domains/{domain_id}/contacts/{contact_sid}/

Параметры

first_name: optional: string
Имя контакта
last_name: optional: string
Фамилия контакта
middle_name: optional: string
Отчество контакта
company: optional: string
Компания контакта
position: optional: string
Должность контакта
comment: optional: string
Комментарий к контакту
{
  "first_name": "Алексей",
  "last_name": "Пупкин",
}

Ответ

HTTP 200 OK

{
  "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин",
}

Полное редактирование контакта

PUT /domains/{domain_id}/contacts/{contact_sid}/

Параметры

first_name: optional: string
Имя контакта
last_name: optional: string
Фамилия контакта
middle_name: optional: string
Отчество контакта
company: optional: string
Компания контакта
position: optional: string
Должность контакта
comment: optional: string
Комментарий к контакту
emails: optional: array
Дополнительные электронные почты (при передаче пустого массива все emails удалятся)
phones: optional: array
Номера телефонов (при передаче пустого массива все phones удалятся)
{
    "emails": ["a.pupkin@corp.test.com"],
    "phones": [
        {
          "phone": "+79123456789",
          "type": "work"
        }
    ],
    "first_name": "Алексей",
    "last_name": "Пупкин",
    "middle_name": "Витальевич",
    "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
    "email": "alex@test.com",
}

Ответ

HTTP 200 OK

{
  "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин",
  "middle_name": "Витальевич",
  "emails": [
    "a.pupkin@corp.test.com",
    "a.pupkin@gmail.com"
  ]
  "phones": [
    {
      "phone": "+79123456789",
      "type": "work"
    }
  ]
}

Получение контакта

GET /domains/{domain_id}/contacts/{contact_sid}/

Ответ

HTTP 200 OK

{
  "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин",
  "middle_name": "Витальевич",
  "emails": [
    "a.pupkin@corp.test.com",
    "a.pupkin@gmail.com"
  ]
  "phones": [
    {
      "phone": "+79123456789",
      "type": "work"
    }
  ]
}

Удаление контакта

DELETE /domains/{domain_id}/contacts/{contact_id}/

Ответ

HTTP 204 OK

{
  "id": 1231,
  "sid": "a1986b78e78e482bbe78e8ce5d7f85ec",
  "email": "alex@test.com",
  "first_name": "Алексей",
  "last_name": "Пупкин",
}