Skip to content

OnSiteMessaging 1.0.0

Send a relevantMessaging message via the On-site Gateway

Endpoints

POST /send

Request body

{
    "accountId": 49,
    "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"
    ]
}

Response 200 OK

Response 404 Not Found

Response 500 Internal Server Error

Schemas

DisplayType

Type: string

RelevantMessagingPayload

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

RelevantMessagingRequest

Name Type
accountId integer(int64)
message RelevantMessagingPayload