Поиск по сайту

API
Главная / API - Контактные данные

Контактные данные

Обновлено 20.01.2023
Скачать в PDF
167 кб
Содержание:

Общие сведения

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

Добавление телефонных номеров и контактных лиц невозможно для контрагентов, являющихся "анонимными" получателями."Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии").

Получение списка контактных лиц и телефонов

Запрос метода

Структура запроса

Адрес метода: https://api.dellin.ru/v2/book/contacts.json

{   
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":1
}

Адрес метода: https://api.dellin.ru/v2/book/contacts.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <addressID>1</addressID>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

ДаintegerID  адреса, по которому нужно получить информацию о контактных лицах и телефонах

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "contacts":[
         {
            "id":1,
            "contact":"Иван Иванович Иванов"
         },
         {
            "id":3,
            "contact":"Петр"
         }
      ],
      "lastUpdate":"2019-05-18 17:23:58",
      "phones":[
         {
            "id":123,
            "phoneNumber":"79002350122",
            "phoneFormatted":"+7 (900) 235-01-22",
            "ext":"55677"
         },
         {
            "id":321,
            "phoneNumber":"375127789955",
            "phoneFormatted":"+375 (12) 778-99-55"
         },
         {
            "id":456,
            "phoneNumber":"495778999999999999",
            "phoneFormatted":null,
            "ext":"0890"
         }
      ]
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <contacts>
         <id>1</id>
         <contact>Иван Иванович Иванов</contact>
      </contacts>
      <contacts>
         <id>3</id>
         <contact>Петр</contact>
      </contacts>
      <lastUpdate>2019-05-18 17:23:58</lastUpdate>
      <phones>
         <id>123</id>
         <phoneNumber>79002350122</phoneNumber>
         <phoneFormatted>+7 (900) 235-01-22</phoneFormatted>
         <ext>55677</ext>
      </phones>
      <phones>
         <id>321</id>
         <phoneNumber>375127789955</phoneNumber>
         <phoneFormatted>+375 (12) 778-99-55</phoneFormatted>
      </phones>
      <phones>
         <id>456</id>
         <phoneNumber>495778999999999999</phoneNumber>
         <phoneFormatted />
         <ext>0890</ext>
      </phones>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generatedAtstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataDataСведения о контрактных лицах и телефонах

Data
Data
ПараметрТипОписание
contactsarray of ContactsМассив данных контактных лиц
contacts.idintegerID контактного лица
contacts.contactstringФИО контактного лица
lastUpdatestring

Дата последнего обновления данных

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

phonesarray of Phones

Массив данных по контактным телефонам

phones.idintegerID контактного телефона
phones.phoneNumberstringКонтактный телефон без форматирования
phones.phoneFormattedstringКонтактный телефон с форматированием. Если форматирование по международному стандарту невозможно, то значение параметра - "null" 
phones.extstringДобавочный номер

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

Создание и редактирование контактных лиц

Запрос метода

Пример запроса (создание контактного лица)

Адрес метода: https://api.dellin.ru/v2/book/contact/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":4,
   "contact":"Иван"
}

Адрес метода: https://api.dellin.ru/v2/book/contact/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <addressID>4</addressID>
   <contact>Иван</contact>
</request>

Пример запроса (редактирование контактного лица)

Адрес метода: https://api.dellin.ru/v2/book/contact/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "contactID":244,
   "contact":"Иван Иванович"
}

Адрес метода: https://api.dellin.ru/v2/book/contact/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <contactID>244</contactID>
   <contact>Иван Иванович</contact>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

Нет*integer

ID адреса, для которого нужно добавить контактное лицо.

*Параметр является обязательным при создании контактного лица. При редактировании контактного лица параметр не используется

contactIDНет*integer

ID контактного лица, данные которого необходимо изменить.

*Параметр является обязательным при редактировании контактного лица. При создании контактного лица параметр не используется

contactДаstringФИО контактного лица

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "state":"new",
      "contactID":244
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>new</state>
      <contactID>244</contactID>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация об отредактированном/добавленном контактном лице
data.statestring

Статус адреса. Возможные значения:

  • "existing" - отредактировано существующее контактное лицо;
  • "new" - создано новое контактное лицо
data.contactIDintegerID отредактированного/добавленного контактного лица

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".

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

Запрос метода

Пример запроса (создание телефона)

Адрес метода: https://api.dellin.ru/v2/book/phone/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "addressID":4,
   "phoneNumber":"79002350122",
   "ext":"0867"
}

Адрес метода: https://api.dellin.ru/v2/book/phone/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <addressID>4</addressID>
   <phoneNumber>79002350122</phoneNumber>
   <ext>0867</ext>
</request>

Пример запроса (редактирование телефона)

Адрес метода: https://api.dellin.ru/v2/book/phone/update.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "phoneID":214,
   "phoneNumber":"79002350122",
   "ext":"0867"
}

Адрес метода: https://api.dellin.ru/v2/book/phone/update.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <phoneID>214</phoneID>
   <phoneNumber>79002350122</phoneNumber>
   <ext>0867</ext>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"

addressID

Нет*integer

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

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

phoneIDНет*integer

ID контактного телефона, который необходимо изменить.

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

phoneNumberДаstring

Контактный телефон. 

Допускаются цифры и знак "+" в начале строк, начинающихся с 7 или 375

extНетstringДобавочный номер, максимум 5 цифр

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":{
      "state":"existing",
      "phoneID":214
   }
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <state>existing</state>
      <phoneID>214</phoneID>
   </data>
</response>

Описание параметров

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataobjectИнформация об отредактированном/добавленном номере телефона
data.statestring

Статус номера телефона. Возможные значения:

  • "existing" - отредактирован существующий номер телефона;
  • "new" - создан новый номер телефона
data.phoneIDintegerID отредактированного/добавленного номер телефона

Обработка ошибок

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".