AlexaConnectivity

Outgoing Messages

GetConnectivityState

Retrieve the connectivity state from the platform implementation.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "GetConnectivityState"
        }
    }
}

GetIdentifier

Retrieve the identifier from the platform implementation.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "GetIdentifier"
        }
    }
}

ConnectivityStateChangeReply

Reply for ConnectivityStateChange message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "ConnectivityStateChange",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "success": {{Bool}}        
    }
}

Payload

Property	Type	Required	Description	Example
success	Bool	Yes	Returns true if connectivity state was processed successfully, false otherwise.

SendConnectivityEventReply

Reply for SendConnectivityEvent message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "SendConnectivityEvent",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "statusCode": {{StatusCode}}        
    }
}

Payload

Property	Type	Required	Description	Example
statusCode	StatusCode	Yes	Represents the delivery status of event.

Incoming Messages

ConnectivityStateChange

Notifies the Engine of a change in the connectivity state. The Engine calls getConnectivityState to retrieve the the connectivity state and communicate any changes to Alexa.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "ConnectivityStateChange"
        }
    }
}

SendConnectivityEvent

Notifies an event in the connectivity to the Engine.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "SendConnectivityEvent"
        }
    },
    "payload": {
        "event": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
event	String	Yes	The stringified JSON containing the event.

GetConnectivityStateReply

Reply for GetConnectivityState message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "GetConnectivityState",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "connectivityState": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
connectivityState	String	Yes	A string representing the connectivity state in structured JSON format.

GetIdentifierReply

Reply for GetIdentifier message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "AlexaConnectivity",
            "action": "GetIdentifier",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "identifier": {{String}}        
    }
}

Payload

Property	Type	Required	Description	Example
identifier	String	Yes	A string representing the identifier.

Enums

StatusCode

Values

Value	Description
"SUCCESS"	The event was sent to AVS successfully.
"FAIL"	The event was not sent to AVS successfully.