Message

Attribute

type

values

default

mandate

comment

type

string

EMAIL,
SMS,
WPSI,
TWITTER,
TELEPHONE

 

true

 

from

string

 

 

true

 

to

string

 

 

true

 

cc

string

 

 

 

 

bcc

string

 

 

 

 

subject

string

 

 

 

 

body

string

 

 

true

 

link

string

 

 

 

 

bodyFormat

string

TEXT,
HTML

 

 

 

mailFormat

string

MIME,
TEXT

 

 

 

importance

string

LOW,
NORMAL,
HIGH

 

 

 

created

date

 

 

 

 

expires

date

 

 

 

 

messageID

string

 

 

 

 

Gateway

Attribute

type

values

default

mandate

comment

provider

string

 

 

true

 

userName

string

 

 

true

 

password

string

 

 

true

 

Proxy

Attribute

type

values

default

mandate

comment

protocol

string

 

 

true

 

address

string

 

 

true

 

port

integer

 

 

true

 

authRequired

boolean

 

false

 

 

userName

string

 

 

 

 

password

string

 

 

 

 


Example:
Method:/communicator /send
Parameters:
{
"message":
{
"type":"SMS",
"from":"0101010101",
"to":"1234567890",
"subject":"test",
"body":"test body"
}
}
Response:
{
"error":0
}

/communicator /listProviders

/communicator /listServices

/communicator /listProtocols

/communicator /listVariables

/communicator /listManufacturers

/communicator /listModels

/communicator /listAll


/communicator /send


Method:/communicator /send
Parameters:
{
"message":{…},
"gateway":{…}, //optional
"proxy":{…}//optional
}
Response:
{
"error":0
}

  • No labels