API commands and script examples

Commands from third-party chats to Planfix

---

newMessage (POST)

Command to send a new message from a third-party chat to Planfix.

---

Call parameters:

Name	Description	Data type/format	Note
cmd	type of operation, in this case newMessage	string
providerId	third-party system identifier	string	cannot contain the symbol "~"
channel	additional channel identifier on the third-party system side	string	not required, can be used as needed.
chatId	unique chat ID	string
planfix_token	Planfix key (token), specified in the integration settings	string
message	message content	string
title	message header	string	not required; if it exists, it's used to create task names
contactId	contact's unique identifier	string
contactName	contact's first name	string
contactLastName	contact's last name	string	not required
contactIco	contact's picture	string	not required
contactEmail	contact's email	string	not required
contactPhone	contact's phone number	string	not required
contactData	additional contact data	string	not required
attachments[name]	attachment (name)	string	not required, several allowed
attachments[url]	attachment (link)	string	not required, several allowed
isEcho	outgoing message	boolean	not required

Sample call:

POST https://test.planfix.ru/chat/api

cmd=newMessage
providerId=superchat
chatId=EFHASFN1239351
planfix_token=303cb962ac59075b964b07152d234b70
message=Hello, I have a question
contactId=57487124
contactName=Ivan
contactLastName=Ivanov
contactIco=https://superchat.io/avatars/183712.png
contactEmail=ivan@ivanov.com
contactPhone=79051234567
contactData=the gas boilers came as expected
attachments[name]=photo1.jpg
attachments[url]=https://superchat.io/files/5444.jpg
attachments[name]=photo2.jpg
attachments[url]=https://superchat.io/files/5445.jpg

Варианты ответа:

HTTP код	Тело	Описание
200		ОК
400	{ error: "Invalid parameters" }	Переданы некорректные параметры
401	{ error: "Invalid token" }	Передан неверный ключ (token)

Команды от ПланФикса к стороннему чату

---

newMessage (POST)

Команда для передачи нового сообщения из ПланФикса в сторонний чат.

---

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

Имя	Описание	Тип/формат данных	Примечание
cmd	тип операции, в данном случае newMessage	string
providerId	идентификатор сторонней системы	string
chatId	уникальный id чата	string
contactPhone	телефон контакта	string	необязательный
channel	дополнительный идентификатор канала на стороне сторонней системы	string	не обязателен, может использоваться при необходимости.
token	ключ (token) стороннего чата, указанный в настройках интеграции	string
message	содержимое сообщения	string
userName	имя ответившего сотрудника	string
userLastName	фамилия ответившего сотрудника	string
userIco	аватар ответившего сотрудника	string
taskEmail	емайл-адрес задачи в ПланФиксе	string
attachments[name]	вложение (имя)	string	необязательный, допускается несколько
attachments[url]	вложение (ссылка)	string	необязательный, допускается несколько

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

POST https://domain/planfix_api.php

cmd=newMessage
providerId=superchat
chatId=EFHASFN1239351
token=202cb962ac59075b964b07152d234b70
message=Здравствуйте, что вас интересует?
userName=Петр
userLastName=Петров
userIco=https://account.planfix.ru/?action=getuserpic&id=77
attachments[name]=файл1.doc
attachments[url]=https://account.planfix.ru/file/aadkapdoa5456454
attachments[name]=файл2.doc
attachments[url]=https://account.planfix.ru/file/aadkapdoa5456455

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

Имя	Описание	Тип/формат данных	Примечание
chatId	уникальный id чата	string
contactId	уникальный идентификатор контакта	string

Варианты ответа:

HTTP код	Тело	Описание
200	{ chatId: "chatId", contactId: "contactId" }	ОК
400	{ error: "Invalid parameters" }	Переданы некорректные параметры
401	{ error: "Invalid token" }	Передан неверный ключ (token)

Перейти

• API для чатов
• Разработчикам: API
• Интеграции