OnSiteMessaging 1.0.0

Send a relevantMessaging message via the On-site Gateway

Endpoints

POST /send

Request body

application/json

{
    "accountId": 242,
    "message": {
        "urn": "string",
        "params": {},
        "programme": "string",
        "initiative": "string",
        "templateId": "string",
        "dict": {},
        "onSiteDisplayType": "FULL_SCREEN",
        "preferredAppKey": "string"
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "accountId": {
            "type": "integer",
            "format": "int64"
        },
        "message": {
            "$ref": "#/components/schemas/RelevantMessagingPayload"
        }
    },
    "required": [
        "accountId",
        "message"
    ]
}

Responses

200 OK404 Not Found500 Internal Server Error

Schemas

DisplayType

Type: string

RelevantMessagingPayload

Name	Type	Description
`dict`
`initiative`	string
`onSiteDisplayType`	DisplayType
`params`
`preferredAppKey`	string
`programme`	string
`templateId`	string
`urn`	string

RelevantMessagingRequest

Name	Type	Description
`accountId`	integer(int64)
`message`	RelevantMessagingPayload