Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

Interface for sending messages on to Creatio using Beesender using Creatio

Path

{HOST}/api/v1.0/sendmessage/{Appid}/{ChannelId}

Method type

POST

...

Name

Description

Data type

Required

Comments

sender

Sender

stringSender

yes

message

Message

Message

yes

clientId

Client identificator

string

yesno

Class structure Sender

Name

Description

Data type

Required

Comments

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

...

Text message sample sent to Creatio

Code Block
breakoutModelanguagewidejson
{
 "sender":
  {
    "id": 4,
    "name": "Alex Wilson",
    "avatar": "https://media.fox9.com/media.fox9.com/photo/2018/03/02/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,

...

Code Block
languagejson
{
      "ok": true
}

If

...

there

...

are

...

errors,

...

then

...

the

...

text

...

of

...

the

...

error

...

will

...

be

...

indicated

...

in

...

the

...

response

...

body,

...

for

...

example,

...

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

...