How do I use the "transmit" API to make ATC speak to a pilot?

First, make sure you have a partner-key, and make sure you've obtained the customer's SayIntentions.AI API key.

From here, you can generate an HTTP POST request to our partner API "transmit" endpoint. Your payload will include the following parameters:

message: {

• text:  The actual message you want ATC to say out loud to the pilot

  PLUS one of the following:

• company:  The virtual airline company code that is speaking to the pilot. (If used, the incoming message will be transmitting on the frequency associated with that virtual airline).
• frequency:  The VHF frequency you want to transmit on.
• position:  The name of the ATC position you want to say the message. Valid options are CLEARANCE, GROUND, TOWER, APPROACH, DEPARTURE, CENTER, FIS, FSS.  Note that "Radar" stations are "APPROACH" and "Information" stations are CENTER.

}

Sample CURL request:

curl -X POST https://partners.sayintentions.ai/a/transmit \

     -H "Content-Type: application/x-www-form-urlencoded" \

     -d "partner_key=pid_TclnMhek86ZOoF8OEFqQAxSd" \

     -d "pilot_key=KuuyMgU" \

     -d 'payload={"message":{"text":"This is a test","position":"TOWER"}}'

Note that in all cases, if the pilot's radio is not currently tuned to an appropriate frequency to receive your message, the message will be queued until the pilot's radio is tuned correctly.  (Up until the end of the flight, at which point the message will be discarded).