Smart API

{
  "ok": "1",
  "commands": "PlayAnnouncement('announce01'); SayNumber(5201); PlayAnnouncement('announce02');"
}

The above command first plays the audio file announce01, then reads the number 5201, and finally plays the audio file announce02.

Smart API Functions

Smart API has several functions, each performing a specific task. Below, we will review each of them.

PlayAnnouncement

This function plays an audio announcement (the audio file must be uploaded previously in the audio section). The function's input is the name or ID of the audio file (for ID, use the format :id).

Format: PlayAnnouncement(<file:string >);

PlayAnnouncement('id:5be6a5f294c28e3f068b4575');

PlayAnnouncement ('filename-nasim');

Playback

The server's default audio files are played, and the input receives the name of the audio file.

Format: Playback(<default-file-name:string >);

Playback('hello-world');

SayNumber

It reads a number sequentially (in the example below, it reads: five thousand two hundred and one).

Format: SayNumber(<number:int>);

SayNumber(5201);

SayDigit

It reads a number digit by digit (in the example below, it reads: one, two, three, nine).

Format: SayDigit(<number:int>);

SayDigit(1239);

SayDuration

It reads the duration (in the example below, it reads: six days, sixteen hours, and fifty-one seconds).

Format: SayDuration(<time:string(d.HH:MM:SS)>);

SayDuration('6.16:0:51');

SayClock

It reads the time (in the example below: twelve hours, fourteen minutes, and nine seconds).

Format: SayClock(<time:string(HH:MM:SS)>);

SayClock('12:14:09');

Reads the date (e.g., in the example: "21st of Ordibehesht, 1395").

Format: SayDate(<date:string(YYYY-MM-DD)>, <calendar:string(gregorian/jalali/hijri)>);

SayDate('1395-02-21', 'jalali');

GetData

Receiving a number from the user.

Format: GetData(<file:string>, <timeout:int>, <max-digit:int>);

GetData('filename-please-enter-number', 10, 1);

By using the :id expression at the beginning of the file name, you can enter the audio file ID.