Sending messages

If you want your service to send messages to Creatio using Beesender, you need to enable message sending in JSON-format for your service.

The address of the connector is a host, which is used when communicating from Creatio. You can find this value in the system setting BeesenderOperatoHost.

The type parameter defines the type of sending message: text, image, file, location. If type == 'text', the text field must be filled in. Same for the rest of types.

SendMessage

Description	Interface for sending messages to Creatio using Beesender
Path	{HOST}/api/v1.0/sendmessage/{Appid}/{ChannelId}
Method type	POST

AppId – your secret key
ChannelId – guid, recieved in test hook

Request Specification

Name	Description	Data type	Required	Comments

Name	Description	Data type	Required
sender	Sender	Sender	yes
message	Message	Message	yes
clientId	Client identificator	string	no

Class structure Sender

Name	Description	Data type	Required	Comments

Name	Description	Data type	Required
id	Your system’s User Id	string	yes
name	Name of your system’s user	string	yes
avatar	Your system’s user avatar link	string	yes

Class structure Message

Name	Description	Data type	Required	Comments

Name	Description	Data type	Required	Comments
type	Message type	string	yes	Possible values: text, image, file, location
text	Message text	string
attachment	Attachment	Attachment

Class structure Attachment

Name	Description	Data type	Required	Comments

Name	Description	Data type
image	Image link	string
location	Location	Location
file	File	File

Class structure Location

Name	Description	Data type	Required	Comments

Name	Description	Data type	Required	Comments
lat	Latitude	string
lng	Latitude	string

Class structure File

Name	Description	Data type	Required	Comments

Name	Description	Data type	Comments
name	File name	string
size	File size	long	In bytes. Not used yet
url	File url	string

Text message sample sent to Creatio

{
 "sender":
  {
    "id": 4,
    "name": "Alex Wilson",
    "avatar": "https://media.fox9.com/media.fox9.com/photo/116.png_360.jpg"
  },
  "message":
  {
    "type": "text",
    "text": "Test text"
  }
}

If the request was successful, then 200 OK is returned with the body, for example,

{
      "ok": true
}

If there are errors, then the text of the error will be indicated in the response body, for example,

{
    "ok": false,
    "error": "hook.message.attachment.image can't be empty"
}