Broadcast Gateway v2

Broadcast gateway service for sending co-ordinated customer messaging

Contact: PST.Callisto PST.Callisto@paddypowerbetfair.com

License: Apache 2.0

Servers

Description	URL
https://bcg.betfair.com/BroadcastGateway/v2	https://bcg.betfair.com/BroadcastGateway/v2

BroadcastGatewayV2

POST /send

Sending messages to customers to channels

Description

Sends a message to customers to channels

Input parameters

Parameter	In	Type	Default	Nullable	Description
`headers`	header	object		No

Request body

application/json

{
    "accountId": 101,
    "programme": "string",
    "initiative": "string",
    "messages": [
        {
            "messageId": "string",
            "expiryDate": "2022-04-13T15:42:05.901Z",
            "payload": {
                "urn": "string",
                "params": {}
            },
            "preferences": [
                {
                    "channels": [
                        {
                            "channel": "ON_SITE"
                        }
                    ]
                }
            ],
            "preferredAppKey": "string",
            "priority": 142,
            "retriedCount": 100
        }
    ],
    "context": {}
}

⚠️ 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",
    "required": [
        "accountId",
        "programme",
        "initiative",
        "messages"
    ],
    "properties": {
        "accountId": {
            "type": "integer",
            "format": "int64"
        },
        "programme": {
            "type": "string",
            "minLength": 1
        },
        "initiative": {
            "type": "string",
            "minLength": 1
        },
        "messages": {
            "type": "array",
            "minItems": 1,
            "items": {
                "$ref": "#/components/schemas/Message"
            }
        },
        "context": {
            "type": "object",
            "additionalProperties": {
                "type": "string"
            }
        }
    }
}

Responses

200 OK400 Bad Request

Schemas

DeliveryChannel

Name	Type	Description
`channel`	string

DeliveryPreference

Name	Type	Description
`channels`	Array<DeliveryChannel>

Message

Name	Type	Description
`expiryDate`	string(date-time)
`messageId`	string
`payload`	MessagePayload
`preferences`	Array<DeliveryPreference>
`preferredAppKey`	string
`priority`	integer(int32)
`retriedCount`	integer(int32)

MessagePayload

Name	Type	Description
`params`
`urn`	string

MessageQueueChannel

Type:

MessageRequest

Name	Type	Description
`accountId`	integer(int64)
`context`
`initiative`	string
`messages`	Array<Message>
`programme`	string

OnSiteChannel