rfc2897.txt

来自「中、英文RFC文档大全打包下载完全版 .」· 文本 代码 · 共 1,807 行 · 第 1/5 页

Cromwell                     Informational                     [Page 13]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Restore Audio:

      Indicates that the provisioned audio segment originally associated
      with the specified segment id is to be restored and that the
      overriding persistent audio is to be deleted.  This parameter is
      carried by the PlayRecord event, although nothing is either played
      or recorded in this case.

6.  Return Parameters

   Each event has an associated set of possible return parameters  which
   are listed in the following tables.

________________________________________________________________________
| Return Parameters                                                     |
|_______________________________________________________________________|
| Symbol    |   Definition                   |  pl    |   pc    |  pr   |
|___________|________________________________|________|_________|_______|
| vi        |   voice interrupt              |        |         |  x    |
| ik        |   interrupting key sequence    |        |   x     |       |
| ap        |   amount played                |        |   x     |  x    |
| na        |   number of attempts           |        |   x     |  x    |
| dc        |   digits collected             |        |   x     |       |
| ri        |   recording id                 |        |         |  x    |
| rc        |   return code                  |  x     |   x     |  x    |
|___________|________________________________|________|_________|_______|

   Voice Interrupted:

      Set to "true" if the initial prompt of a PlayRecord operation was
      interrupted by voice.  Defaults to "false".

   Interrupting Key Sequence:

      The key or key sequence that interrupted the initial prompt of a
      PlayCollect specified using the digit map characters "0" through
      "9" and "A" through "F" as defined in the DTMF Detection Package
      in the Megaco protocol document [6].

   Amount Played:

      The length played of an initial prompt if the prompt was
      interrupted, in 100 ms units.








Cromwell                     Informational                     [Page 14]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Number Of Attempts:

      The number of attempts the user needed to enter a valid digit
      pattern or to make a recording.  Defaults to 1.  Also used as an
      input parameter to specify the number of attempts the user will be
      allowed to enter a valid digit pattern or make a recording.

   Digits Collected:

      The DTMF digits that were collected during a PlayCollect operation
      specified using the digit map characters "0" through "9" and "A"
      through "F" as defined in the DTMF Detection Package in the Megaco
      protocol document [6].

   Recording ID:

      A 32 bit binary integer assigned to audio recorded during the Play
      Record operation.

   Return Code:

      A return code giving the final status  of  the  operation.   Two
      ranges are defined:

                   _________________________________
                   | Range  |        Meaning        |
                   |________|_______________________|
                   |100-199 | successful completion |
                   |300-399 | error                 |
                   |________|_______________________|





















Cromwell                     Informational                     [Page 15]

RFC 2897              MGCP Advanced Audio Package            August 2000


   The following return codes are define:

________________________________________________________________________
|Return Code |                         Meaning                          |
|____________|__________________________________________________________|
|    100     | Success                                                  |
|    300     | Unspecified failure                                      |
|    301     | Bad audio ID                                             |
|    302     | Bad selector type                                        |
|    303     | Bad selector value                                       |
|    304     | Variable type not supported                              |
|    305     | Variable subtype not supported                           |
|    306     | Invalid variable name                                    |
|    307     | Variable value out of range                              |
|    308     | Inconsistent variable specification                      |
|    309     | Alias not found                                          |
|    310     | Extra sequence data                                      |
|    311     | Missing sequence data                                    |
|    312     | Mismatch between play specification and provisioned data |
|    313     | Language not set                                         |
|    314     | Remove override error                                    |
|    315     | Override error                                           |
|    316     | Delete audio error                                       |
|    317     | Unable to record temporary audio                         |
|    318     | Unable to delete temporary audio                         |
|    319     | Unable to record persistent audio                        |
|    320     | Unable to delete persistent audio                        |
|    321     | Unable to override non-existent segment id               |
|    322     | Unable to remove override from non-existent segment id   |
|    323     | Provisioning error                                       |
|    324     | Unspecified hardware failure                             |
|    325     | Syntax error                                             |
|    326     | No digits                                                |
|    327     | No speech                                                |
|    328     | Spoke too long                                           |
|    329     | Digit pattern not matched                                |
|    330     | Max attempts exceeded                                    |
|____________|__________________________________________________________|

   Here are some examples of how the return parameters are used:

   The PlayAnnouncement event completed successfully:

      O: AU/oc(rc=100)

   The PlayAnnouncement event failed because an alias was not found:

      O: AU/of(rc=309)



Cromwell                     Informational                     [Page 16]

RFC 2897              MGCP Advanced Audio Package            August 2000


   The PlayCollect event completed successfully on the user's second
   attempt when the user entered the digits 04375182:

      O: AU/oc(rc=100 na=2 dc=04375182)

   The PlayRecord event was successful on the user's first attempt; the
   id of the recording made by the user is 983:

      O: AU/oc(rc=100 na=1 ri=983)

7.  Segment Descriptors

   Segment descriptors are used with the an, ip, rp, nd, ns, fa, and sa
   parameters to define the segments that make up an announcement.

________________________________________________________________________
|                         Segment Descriptors                           |
|_______________________________________________________________________|
|      Symbol                        |         Definition               |
|____________________________________|__________________________________|
|      32 bit binary number          |         segment identifier       |
|      ts                            |         text to speech           |
|      dt                            |         display text             |
|      si                            |         silence                  |
|      to                            |         tone                     |
|      vb                            |         variable                 |
|____________________________________|__________________________________|

   Segment Identifier:

      A 32 bit binary integer identifying a provisioned entity such as a
      recording, set, sequence, etc.

   Text To Speech:

      Specifies a text string to be converted to speech.

   Display Text:

      Specifies a text string to be displayed on a device.

   Silence:

      Specifies a length of silence to be played in units of 100
      milliseconds.






Cromwell                     Informational                     [Page 17]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Tone:

      Specifies a tone to be played by algorithmic generation.  Exact
      specification of this parameter is tbd.  Most tones will likely be
      recorded, not generated.

   Variable:

      Specifies a voice variable by type, subtype, and value.  Variables
      are more completely defined in a subsequent section of the
      document.

8.  Variables

   The syntax supports two kinds of variables.  Embedded embedded
   variables are variables that have been provisioned as part of a
   segment.  Standalone variables are completely specified in the
   protocol message.

   Typically embedded variables are provisioned along with recorded
   speech, e.g. "A representative will be with you in approximately 5
   minutes.  If you would prefer to leave a voice message, press 1 now".
   where the variable is the number of minutes. This kind of variable is
   often referred to as an embedded variable.

   Variables are specified by the following parameters: type, subtype,
   and value.  Variable types include Date, Money, Number, Time, etc.
   Subtype is a refinement of type.  For example the variable type Money
   might have an associated range of subtypes such as Dollar, Rupee,
   Dinar, etc.  Not all variables require a subtype, and for these
   variables the subtype parameter should be set to null.

   For embedded variables, the type and subtype must be provisioned.
   The value may be provisioned.  If it is not provisioned it must be
   specified as part of the variable reference.  In a list of segments,
   an embedded variable value specification applies only to the segment
   that directly precedes it.  If a segment has multiple embedded
   variables, the values must be given in the order in which the
   variables are encountered when the segment is played.

   Some examples follow below:

   A standalone variable:

      S: pa(an=vb(mny,usd,1153))






Cromwell                     Informational                     [Page 18]

RFC 2897              MGCP Advanced Audio Package            August 2000


   An embedded variable:

      S: pa(an=37<1153>)

   Not all variables, such as the date variable shown in the next
   example, require a subtype.  In that case, the subtype is encoded
   with the value "null":

      S: pa(an=vb(dat,null,101598))

   In some cases it may be desirable to play an announcement that
   contains an embedded variable without playing the variable itself.
   To do this a single "null" is provided for the value:

      S: pa(an=37<null>)

________________________________________________________________________
| Variables Qualifiers                                                  |
|_______________________________________________________________________|
| Symbol  | Definition               |  Type  | Subtype   | Subtype Of  |
|_________|__________________________|________|___________|_____________|
| dat     | date                     |  x     |           |             |
| dig     | digits                   |  x     |           |             |
| gen     | generic                  |        | x         | dig         |
| ndn     | North American DN        |        | x         | dig         |
| dur     | duration                 |  x     |           |             |
| mth     | month                    |  x     |           |             |
| mny     | money                    |  x     |           |             |
| num     | number                   |  x     |           |             |
| crd     | cardinal                 |        | x         | nm          |
| ord     | ordinal                  |        | x         | nm          |
| sil     | silence                  |  x     |           |             |
| str     | string                   |  x     |           |             |
| txt     | text                     |  x     |           |             |
| dsp     | display text             |        | x         | txt         |
| spk     | text to speech           |        | x         | txt         |
| tme     | time                     |  x     |           |             |
| t12     | twelve hour format       |        | x         | tme         |
| t24     | twenty four hour format  |        | x         | tme         |
| ton     | tone                     |  x     |           |             |
| wkd     | weekday                  |  x     |           |             |
|_________|__________________________|________|___________|_____________|

   Date:

      Speaks a date specified as YYYYMMDD (per ISO 8601, International
      Date and Time Notation [7]).  For example "19981015" is spoken as
      "October fifteenth nineteen ninety eight".



Cromwell                     Informational                     [Page 19]

RFC 2897              MGCP Advanced Audio Package            August 2000


   Digits:

      Speaks a string of digits one at a time.  If the subtype is North
      American DN, the format of which is NPA-NXX-XXXX, the digits are
      spoken with appropriate pauses between the NPA and NXX and between
      the NXX and XXXX.  If the subtype is generic, the digits are
      spoken no pauses.

   Duration:

      Duration is specified in seconds and is spoken in one or more
      units of time as appropriate, e.g. "3661" is spoken as "One hour,
      one minute, and one second".

   Money: