Retail CRM Bot API (1.0.0)

Download OpenAPI specification:Download

WebSocket API for receiving events from the Retail CRM Bot platform.

Connection

Receiving events from the Retail CRM Bot platform

Connection for receiving various types of events in real-time

query Parameters

events	string Example: events=message_new,dialog_opened,user_joined_chat Comma-separated list of events to subscribe to
options	string Comma-separated list of additional options

header Parameters

Authorization

required

string

Authorization token for WebSocket connection

Responses

Events

New message event Webhook

Request Body schema: application/json
required

type required	string Value: "message_new"
required	object (MessageData) Message data

Request samples

Payload

Content type

application/json

{"type": "message_new",
"data": {"message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"edited_at": "2019-08-24T14:15:22Z",
"template_code": "string"
}
}
}

Message update event Webhook

Request Body schema: application/json
required

type required	string Value: "message_updated"
required	object (MessageData) Message data

Request samples

Payload

Content type

application/json

{"type": "message_updated",
"data": {"message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"edited_at": "2019-08-24T14:15:22Z",
"template_code": "string"
}
}
}

File update event Webhook

Request Body schema: application/json
required

type required	string Value: "file_updated"
required	object (FileUpdatedData) Updated file data

Request samples

Payload

Content type

application/json

{"type": "file_updated",
"data": {"file": {"id": "string",
"transcription": "string",
"transcription_status": "in_progress"
}
}
}

Message deletion event Webhook

Request Body schema: application/json
required

type required	string Value: "message_deleted"
required	object (MessageData) Message data

Request samples

Payload

Content type

application/json

{"type": "message_deleted",
"data": {"message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"edited_at": "2019-08-24T14:15:22Z",
"template_code": "string"
}
}
}

Message restoration event Webhook

Request Body schema: application/json
required

type required	string Value: "message_restored"
required	object (MessageData) Message data

Request samples

Payload

Content type

application/json

{"type": "message_restored",
"data": {"message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
],
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"edited_at": "2019-08-24T14:15:22Z",
"template_code": "string"
}
}
}

Chat creation event Webhook

Request Body schema: application/json
required

type required	string Value: "chat_created"
required	object (ChatData) Chat data

Request samples

Payload

Content type

application/json

{"type": "chat_created",
"data": {"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
}
}

Chat update event Webhook

Request Body schema: application/json
required

type required	string Value: "chat_updated"
required	object (ChatData) Chat data

Request samples

Payload

Content type

application/json

{"type": "chat_updated",
"data": {"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
}
}

Chat deletion event Webhook

Request Body schema: application/json
required

type required	string Value: "chats_deleted"
required	object (ChatsDeletedData) Deleted chats data

Request samples

Payload

Content type

application/json

{"type": "chats_deleted",
"data": {"chat_ids": [0
]
}
}

Dialog opening event Webhook

Request Body schema: application/json
required

type required	string Value: "dialog_opened"
required	object (DialogData) Dialog data

Request samples

Payload

Content type

application/json

{"type": "dialog_opened",
"data": {"dialog": {"id": 0,
"begin_message_id": 0,
"ending_message_id": 0,
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"responsible": {"type": "user",
"id": 0,
"assigned_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
}
}
}

Dialog assignment event Webhook

Request Body schema: application/json
required

type required	string Value: "dialog_assign"
required	object (DialogAssignData) Dialog assignment data

Request samples

Payload

Content type

application/json

{"type": "dialog_assign",
"data": {"dialog": {"id": 0,
"begin_message_id": 0,
"ending_message_id": 0,
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"responsible": {"type": "user",
"id": 0,
"assigned_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
}
}
}

Dialog closing event Webhook

Request Body schema: application/json
required

type required	string Value: "dialog_closed"
required	object (DialogData) Dialog data

Request samples

Payload

Content type

application/json

{"type": "dialog_closed",
"data": {"dialog": {"id": 0,
"begin_message_id": 0,
"ending_message_id": 0,
"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"responsible": {"type": "user",
"id": 0,
"assigned_at": "2019-08-24T14:15:22Z"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
}
}
}

User status update event (online/offline) Webhook

Request Body schema: application/json
required

type required	string Value: "user_online_updated"
required	object (UserOnlineUpdatedData) User status update data

Request samples

Payload

Content type

application/json

{"type": "user_online_updated",
"data": {"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"online": true,
"connected": true
}
}

User joined chat event Webhook

Request Body schema: application/json
required

type required	string Value: "user_joined_chat"
required	object (UserJoinedChatData) User joined chat data

Request samples

Payload

Content type

application/json

{"type": "user_joined_chat",
"data": {"chat": {"id": 0,
"name": "string",
"avatar": "http://example.com",
"unread": true,
"not_read_messages_count": 0,
"last_activity": "2019-08-24T14:15:22Z",
"author_id": 0,
"customer": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
},
"last_message": {"id": 0,
"type": "text",
"time": "2019-08-24T14:15:22Z",
"chat_id": 0,
"is_read": true,
"is_edit": true,
"scope": "undefined",
"status": "undefined",
"actions": ["string"
],
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"content": "string",
"note": "string",
"quote": {"id": 0,
"type": "text",
"content": "string",
"from": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"time": "2019-08-24T14:15:22Z",
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
]
},
"dialog": {"id": 0
},
"items": [{"id": "string",
"kind": "none",
"type": "string",
"preview_url": "http://example.com",
"size": 0,
"caption": "string",
"width": 0,
"height": 0,
"duration": 0,
"histogram": [0
],
"transcription": "string"
}
],
"transport_attachments": {"suggestions": [{"title": "string",
"payload": "string",
"type": "text"
}
]
},
"order": {"external_id": 0,
"number": "string",
"url": "http://example.com",
"cost": {"value": 0.1,
"currency": "str"
},
"discount": {"value": 0.1,
"currency": "str"
},
"date": "2019-08-24T14:15:22Z",
"status": {"code": "new",
"name": "string"
},
"items": [{"external_id": 0,
"name": "string",
"url": "http://example.com",
"img": "http://example.com",
"price": {"value": 0.1,
"currency": "str"
},
"quantity": {"value": 0.1,
"unit": "string"
}
}
],
"delivery": {"name": "string",
"price": {"value": 0.1,
"currency": "str"
},
"address": "string",
"comment": "string"
},
"payments": [{"name": "string",
"amount": {"value": 0.1,
"currency": "str"
},
"status": {"name": "string",
"payed": true
}
}
]
},
"product": {"id": 0,
"name": "string",
"article": "string",
"cost": {"value": 0.1,
"currency": "str"
},
"img": "http://example.com",
"url": "http://example.com",
"unit": "string",
"revoked_at": "string"
},
"error": {"code": "unknown",
"message": "string"
},
"action": "dialog_opened",
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"reactions": [{"content": "string",
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z"
}
]
},
"last_user_message": {"id": 0
},
"last_dialog": {"id": 0,
"responsible": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
},
"created_at": "2019-08-24T14:15:22Z",
"assigned_at": "2019-08-24T14:15:22Z",
"closed_at": "2019-08-24T14:15:22Z",
"utm": {"source": "string",
"medium": "string",
"campaign": "string",
"term": "string",
"content": "string"
}
},
"members": [{"is_author": true,
"state": "active",
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
],
"waiting_level": "warning",
"waiting_level_transition_time": "2019-08-24T14:15:22Z",
"reply_deadline": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z"
},
"user": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}
}

User left chat event Webhook

Request Body schema: application/json
required

type required	string Value: "user_left_chat"
required	object (UserLeftChatData) User left chat data

Request samples

Payload

Content type

application/json

{"type": "user_left_chat",
"data": {"reason": "string",
"chat": {"id": 0
},
"user": {"id": 0
}
}
}

User data update event Webhook

Request Body schema: application/json
required

type required	string Value: "user_updated"
required	object (UserUpdatedData) User information update data

Request samples

Payload

Content type

application/json

{"type": "user_updated",
"data": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string",
"is_active": true
}
}

Customer data update event Webhook

Request Body schema: application/json
required

type required	string Value: "customer_updated"
required	object (CustomerUpdatedData) Customer information update data

Request samples

Payload

Content type

application/json

{"type": "customer_updated",
"data": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}

Bot data update event Webhook

Request Body schema: application/json
required

type required	string Value: "bot_updated"
required	object (BotUpdatedData) Bot information update data

Request samples

Payload

Content type

application/json

{"type": "bot_updated",
"data": {"id": 0,
"external_id": "string",
"type": "user",
"name": "string",
"avatar": "http://example.com",
"first_name": "string",
"last_name": "string",
"available": true,
"is_blocked": true,
"is_system": true,
"is_technical_account": true,
"username": "string",
"email": "user@example.com",
"phone": "string"
}
}

Channel data update event Webhook

Request Body schema: application/json
required

type required	string Value: "channel_updated"
required	object (ChannelUpdatedData) Channel update data

Request samples

Payload

Content type

application/json

{"type": "channel_updated",
"data": {"channel": {"id": 0,
"transport_id": 0,
"type": "telegram",
"name": "string",
"avatar": "http://example.com",
"is_active": true,
"settings": {"text": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_chars_count": 0,
"markup_formats": ["bold"
]
},
"audio": {"creating": "none",
"deleting": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0
},
"file": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"image": {"creating": "none",
"deleting": "none",
"editing": "none",
"quoting": "none",
"reaction": "none",
"max_item_size": 0,
"max_items_count": 0,
"note_max_chars_count": 0
},
"order": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"product": {"creating": "none",
"deleting": "none",
"editing": "none",
"reaction": "none",
"quoting": "none"
},
"customer_external_id": "any",
"sending_policy": {"after_reply_timeout": "no",
"new_customer": "no",
"outgoing": "allowed"
},
"status": {"delivered": "none",
"read": "none"
},
"suggestions": {"email": "none",
"phone": "none",
"text": "none",
"url": "none"
},
"template": {"creation": true,
"sending": true
},
"whatsapp": {"channel_quality": "high",
"channel_status": "connected",
"tier": 0
},
"reactions": {"dictionary": ["string"
],
"max_count": 0
}
}
}
}
}

Retail CRM Bot API (1.0.0)

Connection

Receiving events from the Retail CRM Bot platform

query Parameters

header Parameters

Responses

Events

New message event Webhook

Request Body schema: application/jsonrequired

Request samples

Message update event Webhook

Request Body schema: application/jsonrequired

Request samples

File update event Webhook

Request Body schema: application/jsonrequired

Request samples

Message deletion event Webhook

Request Body schema: application/jsonrequired

Request samples

Message restoration event Webhook

Request Body schema: application/jsonrequired

Request samples

Chat creation event Webhook

Request Body schema: application/jsonrequired

Request samples

Chat update event Webhook

Request Body schema: application/jsonrequired

Request samples

Chat deletion event Webhook

Request Body schema: application/jsonrequired

Request samples

Dialog opening event Webhook

Request Body schema: application/jsonrequired

Request samples

Dialog assignment event Webhook

Request Body schema: application/jsonrequired

Request samples

Dialog closing event Webhook

Request Body schema: application/jsonrequired

Request samples

User status update event (online/offline) Webhook

Request Body schema: application/jsonrequired

Request samples

User joined chat event Webhook

Request Body schema: application/jsonrequired

Request samples

User left chat event Webhook

Request Body schema: application/jsonrequired

Request samples

User data update event Webhook

Request Body schema: application/jsonrequired

Request samples

Customer data update event Webhook

Request Body schema: application/jsonrequired

Request samples

Bot data update event Webhook

Request Body schema: application/jsonrequired

Request samples

Channel data update event Webhook

Request Body schema: application/jsonrequired

Request samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required