Интеграция в свою CRM-систему

С помощью данного api TelefUM сможет полноценно работать с любой CRM-системой.

1. Исходящие звонки из карточки контакта

Для реализации исходящих звонков необходимо телефонные звонки снабдить ссылкой “telf:”
Пример: telf:0123456789

2. Получение контактных данных

Входные параметры:

  • тип запроса (“find”)
  • логин
  • пароль (или ключ API)
  • номер телефона

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

https://mysite.com/rest?typereq=find&phone=0123456789&login=12345&password=999999

Выходные параметры:

  • id контакта
  • Тип контакта  (например: “Лид”, “Контакт”, Компания”)
  • Имя контакта
  • Имя компании
  • Описание
  • Количество найденных контактов

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

<response>
	<item>
	<id>123</id>
        <typecont>contact</typecont>
	<name>Василий Петрович</name>
	<company>ООО Резюме</company>
	<description>Компания по трудоустройству</description>
	</item>
 
	<item>
	<id>123</id>
        <typecont>contact</typecont>
	<name>Иван Павлович</name>
	<company>ООО Невидимка</company>
	<description>Компания по охране</description>
	</item>
 
	<total>2</total>
</response>

Ответ в случае ошибки авторизации:

<response>
	<result>error</result>
	<description>Неправильный логин или пароль</description>
</response>

3. Создание нового контакта

Входные параметры:

  • тип запроса (“addcont”)
  • логин
  • пароль (или ключ API)
  • номер телефона
  • имя контакта
  • тип контакта (например: “Лид”, “Контакт”, Компания”)
  • источник контакта (т.е. откуда пришел контакт. Применяется в случае необходимости отслеживания рекламного телефонного трафика)

Внимание: Ваша система должна указать в качестве лица, кто создал контакт – того пользователя, чьи учетные данные используются в данном запросе.

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

https://mysite.com/rest?typereq=addcont&typecont=contact&phone=0123456789&name=Имя%20контакта&login=12345&password=999999&x_pstn=+79012222222

Выходные параметры:

  • результат (ok/error)
  • id созданного контакта (если успешно)
  • Описание результата

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

<response>
	<result>ok</result>
	<id>3453</id>
	<typecont>contact</typecont>
	<description>Контакт добавлен</description>
</response>
<response>
	<result>error</result>
	<description>Не указан номер телефона</description>
</response>

4. Создание нового события (звонок, смс)

Входные параметры:

  • тип запроса (“addevent”)
  • логин
  • пароль (или ключ API)
  • id контакта
  • тип контакта (например: “Лид”, “Контакт”, Компания”)
  • тема события
  • описание события

Внимание: Ваша система должна указать в качестве лица, кто создал событие – того пользователя, чьи учетные данные используются в данном запросе.

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

https://mysite.com/rest/
 
typereq=addevent
id=6789
typecont=contact
subj=Входящий%20Звонок
desc=Длительность%203:54
login=12345
password=999999

Выходные параметры:

  • результат (ok/error)
  • id созданного события (если успешно)
  • Описание результата

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

<response>
	<result>ok</result>
	<idev>3453</idev>
	<description>Событие добавлено</description>
</response>
<response>
	<result>error</result>
	<description>Не указано id-контакта</description>
</response>

5. Открытие карточки контакта в браузере

Параметры:

  • id контакта
  • тип контакта (например: «Лид», «Контакт», Компания».)

Пример:

https://mysite.com/card?id=24342&typecont=contact

При переходе по данной ссылке должна открываться карточка контакта

6. Открытие окна поиска контактов по номеру телефона

Параметры:

  • Номер телефона

Пример:

https://mysite.com/search?phone=0123456789

При переходе по данной ссылке должна открываться страничка поиска, где в результатах поиска будут отображены контакты, у которых есть данный телефон