Schema Types

Table of Contents

Query

Field Argument Type Description
tags Tags list tags statistics
pageId String
subscribtions Subscribtions fetch user ids for selected tag
include [String!]
exclude [String!]
pageId String
limit Int
lastKey String
campaign Campaign get a campaign by ID
campaignId String!
campaigns Campaigns list of user defined campaigns
limit Int
lastKey String
condition CampaignsCondition
version String! returns the API version
unsuccessfulSubscribers Subscribtions export subscribtions from campaigns
campaignId String
sentWithoutReaction Boolean
pageId String

Mutation

Field Argument Type Description
validateBot ValidationResult validate conversation data
bot Any!
updateBot Boolean invalidate a conversation cache in the chatbot
postBack PostBackResult send a message to any user
pageId String!
senderId String!
action String!
data Any
createCampaign Campaign create a new campaign
campaign CreateCampaignInput!
updateCampaign Campaign update a campaign
campaignId String!
update UpdateCampaignInput!
removeCampaign Boolean remove a campaign
campaignId String!
runCampaign QueuingResult run a campaign
campaignId String!

Objects

Campaign

Field Argument Type Description
id String!
name String!
action String!
data String
include [String]!
exclude [String]!
pageId String
sliding Boolean
slide Int
slideRound Int
active Boolean!
in24hourWindow Boolean!
startAt Float
allowRepeat Boolean!
type String
sent Int!
failed Int!
delivery Int!
read Int!
notSent Int!
leaved Int!
queued Int!
negative Int!
positive Int!
hasCondition Boolean!
condition String

Campaigns

Field Argument Type Description
data [Campaign]!
lastKey String

PostBackResult

Field Argument Type Description
status Int

QueuingResult

Field Argument Type Description
queued Int!

Subscribtion

Field Argument Type Description
pageId String
senderId String

Subscribtions

Field Argument Type Description
data [Subscribtion]!
lastKey String
count Int!

Tag

Field Argument Type Description
tag String!
subscribtions Int!

Tags

Field Argument Type Description
data [Tag]!
lastKey String

ValidationResult

Field Argument Type Description
ok Boolean!
error String

Inputs

CampaignsCondition

Field Type Description
active Boolean
sliding Boolean

CreateCampaignInput

Field Type Description
name String!
action String!
data String
include [String]!
exclude [String]!
pageId String
sliding Boolean
slide Int
slideRound Int
active Boolean!
in24hourWindow Boolean!
startAt Float
allowRepeat Boolean!
type String
hasCondition Boolean!
condition String

UpdateCampaignInput

Field Type Description
name String
action String
data String
include [String]
exclude [String]
pageId String
sliding Boolean
slide Int
slideRound Int
active Boolean
in24hourWindow Boolean
startAt Float
allowRepeat Boolean
type String
hasCondition Boolean
condition String

Scalars

Any

Boolean

The Boolean scalar type represents true or false.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

results matching ""

    No results matching ""