Skip to main content

Interface: Message

Say Example:

{
    "type": "say",
  "sayLanguage": "en-gb",
  "sayVoice": "Polly.Amy",
  "sayMessage": "I am going to say this message!"
}

Play Example:

{
  "type": "play",
  "url": "https://example.com/myMessage.mp3",
}

Properties​

sayLanguage​

• Optional sayLanguage: string

Language for "Say".

  • Required if type is say

See

RaceHelpers.getTTSLanguages

sayMessage​

• Optional sayMessage: string

Message to be used for say.

  • Required if type is say

sayVoice​

• Optional sayVoice: string

Voice for "Say".

  • Required if type is say

See

RaceHelpers.getTTSVoices

type​

• type: "none" | "say" | "play" | "twiml"

Message Type

url​

• Optional url: string

URL of Audio File to Play.

  • Required if type is play or twiml