idnits 2.17.1 draft-ietf-megaco-basicpkg-00.txt: ** The Abstract section seems to be numbered Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Cannot find the required boilerplate sections (Copyright, IPR, etc.) in this document. Found some kind of copyright notice around line 1437 but it does not match any copyright boilerplate known by this tool. Expected boilerplate is as follows today (2024-04-26) according to https://trustee.ietf.org/license-info : IETF Trust Legal Provisions of 28-dec-2009, Section 6.a: This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 2: Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 3: This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document is more than 15 pages and seems to lack a Table of Contents. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. == There are 61 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. Miscellaneous warnings: ---------------------------------------------------------------------------- == Line 76 has weird spacing: '...ication of th...' == Line 354 has weird spacing: '...defined by th...' == Line 925 has weird spacing: '...ftkeyId int...' == Line 935 has weird spacing: '...uration sof...' == Line 946 has weird spacing: '...ftkeyId inte...' == (3 more instances...) -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- Couldn't find a document date in the document -- date freshness check skipped. -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) No issues found here. Summary: 7 errors (**), 0 flaws (~~), 8 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Engineering Task Force Mike Kallas(Editor) 2 Internet Draft Nortel Networks 3 Document: draft-ietf-megaco-basicpkg-00.txt Zacharias Bilalis(editor) 4 Date: September 29 1999 Siemens 5 Expires: March 29 2000 7 Contributions by: 8 Klaus Hoffmann Siemens 9 Klaus Pulverer Siemens 10 Peter Blatherwick Nortel 11 Bob Bell Cisco Systems 12 Markku Korpi Siemens 13 Tom Taylor Nortel Networks 14 Richard Bach Nortel 15 Christian Ruppelt Siemens 17 Megaco/H.248 Generic Packages 19 Status of this Memo 21 This document is an Internet-Draft and is in full conformance with 22 allprovisions of Section 10 of RFC2026. 24 Internet-Drafts are working documents of the Internet Engineering 25 Task Force (IETF), its areas, and its working groups. Note that 26 other groups may also distribute working documents as Internet- 27 Drafts. 29 Internet-Drafts are draft documents valid for a maximum of six 30 months and may be updated, replaced, or obsoleted by other documents 31 at any time. It is inappropriate to use Internet- Drafts as 32 reference material or to cite them other than as "work in progress." 34 The list of current Internet-Drafts can be accessed at 35 http://www.ietf.org/ietf/1id-abstracts.txt 37 The list of Internet-Draft Shadow Directories can be accessed at 38 http://www.ietf.org/shadow.html. 40 1. Abstract 42 This document is a proposal to add new event/signal packages to the 43 Megaco protocol to control line side gateways connected to a variety 44 of business and hone telephones. And trunk side gateways connected 45 to the PSTN. 47 NOTE: This document is a work in progress, known to be incomplete in 48 some areas, and leaves several issues unresolved. 50 2. Introduction 52 The first set of packages (section 3.1 to 3.7) addresses the 53 requirements of line side gateways. These packages combine signals 54 and events that apply to multiple types of gateways connected to 55 line side devices. The line side devices 56 to be supported are: 58 Analog Phone (Tone and Pulse)(Black Phone) 59 High End Home Phone 60 Alternative access phone (cable modem, ADSL, Fixed Wireless) 61 ADSI Phone 62 Analog Business Phone 63 Digital Business Phone 64 IP Business Phone 66 The second set of packages (sections 3.8 to 3.12) addresses the 67 requirements of trunk side gateways. These gateways connect the IP 68 world to the PSTN through trunk lines. 70 2.1 Assumptions: 72 Ephemeral terminations are selected by MG, `static' terminations are 73 selected by the MGC. 74 In case that the dialed number is unallocated, the respective "no 75 circuit tone" is national specified. 76 3. Addition/Modification of the following to chapter `7.3.2.9 Local 77 Descriptor' of H.248: 78 The Mode parameter indicates the relation between the Termination 79 and the "star" connection of the Context. The allowed values are 80 "send only" (sendonly), "receive only" (recvonly), "send/receive" 81 (sendrecv), "inactive" (inactive), "outofservice" , "loopback" (as 82 given in ITU-T Recommendation Q.724 for the continuity check 83 procedure, where the check loop is connected to the go and return 84 path) and "test" (test). "Send" and "Receive" are with respect to 85 the Termination, so that, for example, a stream set to mode=sendonly 86 can talk but it cannot listen. 88 2.2 Abbreviations 90 AAA Authentication Authorization and Accounting 91 CAS Channel Associated Signalling 92 ISUP ISDN User Part 93 L2TP Layer 2 Tunnelling Protocol 94 NAS Network Access Server 95 PPP Point to Point Protocol 96 RADIUS Remote Authentication Dial User Service 97 RTP Realtime Transport Protocol 98 TUP Telephone User Part 100 2.3 Definitions: 102 String: Null terminated, 8-bit Unicode UTF-8 string 103 Integer: 4 byte signed integer 104 Character: Unicode UTF-8 encoding of a single letter 105 (could be more than 1 octet) 107 3. Signal and Event packages 109 3.1 Generic audio Package 111 Short name: gaudio 113 This package is used to detect and apply audio tones. 115 3.1.1 Properties Audit Information 117 3.1.1.1 Gateway Audit Information 119 The following is returned as a result of Audit command at the root 120 MG: 122 3.1.1.1.1 listoftones 124 Short name tlist 126 String of toneids whose definition is available on the MG, separated 127 by `/'. Default toneids could be modified using the deftone signal. 128 New tones could also be defined using deftone. 130 Example: "mt/fd/lt" 132 Toneids are described later 134 3.1.1.2 Termination Audit Information 136 The following is returned as a result of Audit command at a 137 particular physical device termination. 139 None 141 Events 142 3.1.2.1 Event Configuration 144 3.1.2.1.1 ToneStartDetected 146 Short name tonestdt 148 Configuration Parameters: 150 streamid id of audio stream to detect tones on. 152 Return value: integer 0 Success 153 1 streamid not recognized 154 99 undetermined error 156 3.1.2.1.2 ToneEndDetected 158 Short name toneenddt 160 Configuration Parameters: 162 streamid id of audio stream to detect tones on. 164 Return value: integer 0 Success 165 1 streamid not recognized 166 99 undetermined error 168 3.1.2.1.3 LongToneDetected 170 Short name lgtonedt 172 Configuration Parameters: 174 streamid id of audio stream to detect tones on. 175 longduration value of long duration to test against in ms. 177 Return value: integer 0 Success 178 1 streamid not recognized 179 99 undetermined error 181 3.1.2.2 Observed events 183 3.1.2.2.1 ToneStartDetected 185 Short name tonestdt 187 Event Parameters: 189 toneId Short string 190 nameStr the name of the tone in text 192 3.1.2.2.2 ToneEndDetected 194 Short name toneenddt 196 Event Parameters: 198 toneId Short string 199 nameStr the name of the tone in text 200 duration is in milliseconds and is the duration of the continual 201 detection of the tone. 203 3.1.2.2.3 LongToneDetected 205 Short name lgtonedt 207 This event is reported if a tone is continuously present for 208 "longduration" specified in the configure parameters above. 210 Event Parameters: 212 toneId Short string 213 nameStr the name of the tone in text 215 Detectable ToneIds: 217 mt - Modem detected 218 ft - Fax tone detected 219 ld - Long duration connection 220 pat(###)- Pattern ### detected ### is between 000 and 999 221 rt - Ringback tone 222 rbk(###)- Ring back on connection ??? 223 cf - Confirm tone 224 cg - Network Congestion tone 225 it - Intercept tone 226 pt - Preemption tone 227 of - report failure 228 dtmf0 229 dtmf1 230 dtmf2 231 dtmf3 232 dtmf4 233 dtmf5 234 dtmf6 235 dtmf7 236 dtmf8 237 dtmf9 238 dtmf* 239 dtmf# 240 dtmfA 241 dtmfB 242 dtmfC 243 dtmfD 245 3.1.3 Signals 247 3.1.3.1 PlayTone 249 short name playtone 251 Signal Parameters: 253 streamid id of audio stream to play tones on. 254 toneid Tone to be played 255 signaltype Possible values: 256 "BR" brief duration (provisioned / implied) 257 "ON" Play until instructed to stop 258 "TO" Play until timed out 259 duration timeout duration in ms 261 Return value: integer 0 Success 262 1 streamid not recognized 263 2 toneid not recognized 264 3 signaltype error 265 99 undetermined error 267 3.1.3.2 StopTone 269 short name stoptone 271 stop tone play on streamid 273 Signal Parameters: 275 streamid id of audio stream to detect tones on. 277 Return value: integer 0 Success 278 1 streamid not recognized 279 99 undetermined error 281 ToneIds: 283 aw - Answer Tone 284 bz - Busy Tone 285 wt - Call Waiting Tone 286 dl - Dial Tone 287 rb - Ringback 288 nbz - Network Busy Tone (reorder or fast cycle busy) 289 rs - Ring Splash Tone 290 p - Prompt Tone 291 e - Error Tone 292 sdl - Stutter Dial Tone (??) 293 v - Alerting Tone 294 y - Recorder Warning Tone (??) 295 sit - SIT Tone (??) 296 z - Calling Card Service Tone (??) 297 ot - Off Hook Warning Tone 298 s(###) - Distinctive Tone Pattern Tone 299 sil - Silence Tone 301 [editor's note: 302 semantic for all all tonid's must be defined 303 non internatinal taken off list 304 add bob's tone definition stuff 305 Audit: gives you pre-provisioned tones definitions 306 Def tone allows you to overwrite existing tones or add others. When 307 you delete tone you revert to original] 309 3.1.3.2 Define Tone 311 short name deftone 313 define a new tone for playback or redefine an existing tone. If 314 deftone is sent to a termination in a specific context, the tone 315 definition or redefinition would only be temporary and available in 316 the context 318 The syntax for the tone definition parameter is recursive and uses 319 parenthesis as a delimiter of elements. 321 Note: to remove a dynamically defined tone, simply issue the signal 322 with the desired ToneId and a NULL deftone paramenter. Only 323 dynamically defined tones (i.e. tones defined using deftone) may be 324 deleted. 326 DefToneCmd = ToneID "=" DefToneString 328 DefToneString = "(" DefToneElement ["*" RepeatCount ] ")" 329 [","/"+"/"X" 330 DefToneString] 331 NOTE: a separator of `,' indicates that the next definition follows 332 sequentially in time; a separator of `+' indicates that the 333 following tone is to be mixed with the previous tone and is 334 simultaneous with it; a separator of `X' indicates that the first 335 tone is modulated by the second tone. 336 Note: Recursion is limited to a maximum of 32 Levels. All IPPhone 337 MGs must support at least 4 levels of recursion. 339 RepeatCount = %d1-32767 / %d0 340 NOTE: repeatcount of 0 indicates infinite repeating. 342 DefToneElement = ToneName ["," ToneDuration [ "," ToneAmplitude ]] 343 ToneName = ToneID / "#"FreqValue / "&"AnnouncementParameterList 344 ToneID = 1*VCHAR; Unique tone identity string or value 345 FreqValue = %d0-4000; in Hertz 346 AnnouncementParameterList = AnnouncementID ["," SubstitutionString] 347 AnnouncementID = 1*VCHAR; Unique identifier for an audio 348 announcement 349 SubstitutionString = """1*VCHAR"""; a TTS string to be inserted into 350 an 351 ; announcement. 352 ToneDuration = %d1-32767 / %d0 ; In Milliseconds 353 NOTE: ToneDuration of 0 indicates infinite duration or duration 354 defined by the ToneID. 355 ToneAmplitude = "-"%d32-1 / %d0; In dBm0 357 An examples of some tone definitions follows. 359 ReorderTone = ((((#480)+(#620)),250,-24),(sil,250))*0 361 SITTone = (#950,330,-24), (sil,30), (#1400,330,-24), (sil,30), 362 (#1800,330,-24), (sil,30) 364 NumberYouHaveDialed = (SITTone), (&NumberDialed,"555-1234") 366 Note: above tone definitions are from SR-TSV-002275. 368 Return value: integer 0 Success 369 4 Tone definition not 370 understood 371 99 undetermined error 373 3.2 Generic DTMF Package 375 Short name gdtmf 376 This package it used to detect and generate tones on the analog 377 trunk or line connection on a media gateway. 379 3.2.1 Properties audit 381 3.2.1.1 Gateway Audit Information 383 The following is returned as a result of Audit command at the root 384 MG: 386 3.2.2 Events 388 3.2.2.1 Event Configuration 390 3.2.2.1.1 ToneDetected 392 Short name tonedt 394 Configuration Parameters: 396 streamid id of audio stream to detect tones on. 397 listoftones a string containing one or more of the dtmftoneid's to 398 be detected, seperated by / 399 Example: "0/1/2/3/4/5/6/7/8/9/*/#". 401 dtmftoneid's: 402 `0','1','2','3','4','5','6','7','8','9','*','#','A','B','C','D','X' 403 `X' represents all digits from 0 to 9. 404 `L' Long Duration 406 'A','B','C','D' can be redefined using the deftone signal in the 407 previous packages 409 Return value: integer 0 Success 410 1 streamid not recognized 411 2 toneid not recognized 412 99 undetermined error 414 3.2.2.1.2 SilenceDetected 416 Short name silencedt 418 This event is triggered after a period of silence has occurred 419 following the detection of a DTMF digit. 421 Configuration Parameters: 423 streamid id of audio stream to detect tones on. 424 duration Silence duration that would trigger the event in ms. 426 Return value: integer 0 Success 427 1 streamid not recognized 428 99 undetermined error 430 3.2.2.2 Observed Events 432 3.2.2.2.1 ToneDetected 434 Short name tonedt 436 Event Parameters: 438 eventtype Possible values: 439 "MULTI": multiple digits have been accumulated and 440 sent. 441 "START": one tone start detected 442 "LONG": one tone has been detected for more than 2 seconds 443 (Configurable) 444 "END': one tone end detected. 446 content a string containing one or more dtmftoneid's 448 duration this parameter is used when eventtype is "END" is 449 represents the total duration for which the tome was detected in ms 451 dtmftoneid's: 452 `0','1','2','3','4','5','6','7','8','9','*','#','A','B','C','D' 454 3.2.2.2.2 SilenceDetected 456 Short name silencedt 458 Event Parameters: 460 3.2.3 Signals 462 3.2.3.1 PlayTone 464 short name playtone 466 Signal Parameters: 468 streamid - integer: id of audio stream to play tones on. 469 dtmftoneid - integer: Tone to be played 470 signaltype - string Possible values: 471 "BR" brief duration (provisioned / implied) 472 "ON" Play until instructed to stop 473 "TO" Play until timed out. 474 duration timeout duration in ms 475 possible value for dtmftoneid: 477 0 - dtmf0 478 1 - dtmf1 479 2 - dtmf2 480 3 - dtmf3 481 4 - dtmf4 482 5 - dtmf5 483 6 - dtmf6 484 7 - dtmf7 485 8 - dtmf8 486 9 - dtmf9 487 10 - dtmf* 488 11 - dtmf# 489 12 - dtmfA 490 13 - dtmfB 491 14 - dtmfC 492 15 - dtmfD 494 16 - echo dtmf0 495 17 - echo dtmf1 496 18 - echo dtmf2 497 19 - echo dtmf3 498 20 - echo dtmf4 499 21 - echo dtmf5 500 22 - echo dtmf6 501 23 - echo dtmf7 502 24 - echo dtmf8 503 25 - echo dtmf9 504 26 - echo dtmf* 505 27 - echo dtmf# 506 28 - echo dtmfA 507 29 - echo dtmfB 508 30 - echo dtmfC 509 31 - echo dtmfD 511 echo dtmfs are intended to be played back to the user and will have 512 a lower amplitude than dtmfs. 514 Return value: integer 0 Success 515 1 streamid not recognized 516 2 toneid not recognized 517 (dtmftoneid) 518 3 signaltype error 519 99 undetermined error 521 3.2.3.2 StopTone 523 short name stoptone 524 stop tone play on streamid. Cancels all playtone signals. 526 Signal Parameters: 528 streamid id of audio stream to detect tones on. 530 Return value: integer 0 Success 531 1 streamid not recognized 532 99 undetermined error 534 3.3. Dialpad Package 536 Short name: dpad 538 The dialpad package is used to represent a standard 10 digit key pad 539 plus the '*', '#', A, B, C, and D keys. 541 Standard dialpad identifiers (dialpadId) include: 543 '0','1','2','3','4','5','6','7','8','9','*','#','A','B','C','D' 545 3.3.1. Properties Audit 547 3.3.1.1 Gateway Properties Audit 549 None. 551 3.3.1.2 Termination Properties Audit 553 3.3.1.2.1 number of keys: short name nkeys 555 10 keys are 0-9 556 12 keys are 0-9,*,# 557 16 keys are 0-9,*,#,A,B,C,D 559 3.3.2. Events 561 3.3.2.1. Event Configuration 563 3.3.2.1.1 Dialpad Key Down: Short name kdwn 565 Configure Parameters: 567 None 569 3.3.2.1.2 Dialpad Key Up: Short name kup 570 Configure Parameters: 572 None 574 3.3.2.2. Observed Events 576 3.3.2.2.1. Dialpad Key Down: Short name kdwn 578 Event Parameters: 580 dialpadId - Character: representing key pressed 582 Standard dialpad identifiers (dialpadId) include: 584 '0','1','2','3','4','5','6','7','8','9','*','#','A','B','C','D' 586 3.3.2.2.2. Dialpad Key Up: Short name kup 588 Event Parameters 590 dialpadId - character: representing key pressed 591 duration - integer = dialpad key press duration in ms 593 3.3.3 Signals 595 3.3.3.1 Dialpad Echo: Short name echo 597 It turn DTMF tone echo on and off. It is typically used to feedback 598 keypresses. 600 Signal parameters: 602 echoCtrl - String: "On" or "Off". default = on 603 direction - Character: `U' = to user / `A' = Away from user / `B' 604 = Both 605 duration - Integer: tone duration in ms (default = "track 606 keypad") 608 Note: Direction parameter is intend specify how the context streams 609 the injected tones, `U' (towards the audio transducer), or `A' 610 (towards the network through RTP). DTMF tones that are played 611 through the audio transducers are at reduced amplitude. 613 3.3.4. Statistics 615 None. 617 3.4. Function Key Package 619 Short name: fkey 621 Events associated with the common telephone function keys are 622 defined in this package. This allows, for example, line keys to be 623 implemented without specific knowledge of the physical layout of the 624 telephone. Function keys may have well known names, for example: 625 Hookswitch, Hold, or Forward. Function keys may also be assigned a 626 name identifier by the MGC, which is returned as part of the key 627 events. 629 3.4.1. Properties Audit 631 Gateway Properties Audit 633 3.4.1.2 Termination Properties Audit 635 3.4.1.2.1 Function Key List 637 Short name: list 639 Return values: Returns list of all function keys 640 list - String representing: (key *(,key)) 641 key = (id, name if assigned, key name is settable or not). 643 list Example: "(0,,Y),(1,LineKey1,Y),(2,52489,Y),(3,Hold,N)" 645 The standard function key well known names include the following 646 strings: 648 "hksw" - Hookswitch 649 "hold - Hold 650 "conf" - Conference 651 "fwrd" - Forward 652 "tsfr" - Transfer 653 "l???" - LineKey 654 "f???" - FunctionKey 656 3.4.2. Events 658 3.4.2.1. Event Configuration 659 3.4.2.1.1 Function Key Down: Short name kdwn 661 3.4.2.1.2 Dialpad Key Up: Short name kup 663 3.4.2.2. Observed Events 665 3.4.2.2.1 Function Key Down: Short name kdwn 667 Event Parameters: 669 keyId - integer: function key id 670 nameStr - string: containing stored name value 672 3.4.2.2.2 Dialpad Key Up: Short name kup 674 Event Parameters: 676 keyId - integer: function key id 677 nameStr - string: containing stored name value 678 duration - integer: key press duration in milliseconds 680 3.4.3. Signals 682 3.4.3.1 Assign Function Key Name 684 Short name: asgnm 686 Signal Parameters: 688 keyId - integer: function key id 689 nameStr - string: containing stored name value 691 3.4.4 Statistics 693 None 695 3.5 Indicator Package 697 Short name: ind 699 Signals associated with the common telephone indicators are defined 700 in this package. This allows, for example, indicators to be 701 implemented without specific knowledge of the physical layout of the 702 telephone. Indicators may have well known identifier names, for 703 example: message waiting, hold, line active, and may be alterable as 704 in Function Key Package. 706 3.5.1 Properties Audit 708 Gateway Properties Audit 710 3.5.1.2 Termination Properties Audit 712 3.5.1.2.1 Indicators List 714 Short name: list 716 Return values: Returns list of all indicators 717 List - String representing: (indicator *(,indicator)) 718 indicator = (id, name if assigned, attributes). 720 List Example: "(0,,Y),(1,LineKey1,Y),(2,52489,Y),(3,Hold,N)" ??? 721 Peter 723 The standard indicator well known names include: 725 "mwat" - Message waiting indicator 726 "hold" - Hold On/Off 727 "conf" - Conference 728 "ring" - Ringer/Alerter 729 "l???" - Line 730 "f???" - Function indicator 732 The standard attributes include: 734 * on, off, blink, fast blink, slow blink, invert, color. ???? 736 [[ Note: Need to define attributes appropriate for audible alerts 737 such as ringing, page, possibly error tones etc. These may need to 738 be aligned with other Megaco packages. ]] 740 [[ ISSUE: Should consider additional package specifically for 741 audible indicators. Left for further study. ]] 743 3.5.2. Events 745 3.5.2.1. Event Configuration 747 None. 749 3.5.2.2. Observed Events 750 None. 752 3.5.3. Signals 754 3.5.3.1. Set Indicator 756 Short name: SetInd 758 Signal Parameters: 760 indicatorId Integer 761 attribute on, off, blink, fast_blink, slow_blink, invert, color. 762 ??? 764 {{Add nameStr parameter, to allow SetIndicator by name? Could also 765 be separate command, eg. SetIndicatorByName() }} 767 5.4.3.2. Set Name 769 Short name: SetName 771 indicatorId Integer 772 nameStr string 774 5.4.4. Statistics 776 None. 778 3.6. Monochrome Text Display Package 780 Short name: mtdisp 782 The text display package supports signals associated with the text 783 display elements. 785 Carriage return is supported in-string, and moves 786 the text input to the beginning of the next line, clearing the 787 remainder (if any) of the current line. Text wrapping is not 788 provided. 790 Unicode is supported to provide support for multiple languages. The 791 Unicode Standard, Version 2.0 or ISO/IEC 10646-1:1993 shall be the 792 definitive standard intended when the term Unicode is used within 793 the context of this document. All text display elements shall at 794 least support the Unicode pages U+0000 -> U+00ff as the basic 795 character set. All of the text strings shall be encoded using UTF-8 796 as defined in ISO/IEC 10646 AM1. 798 Property Audit 800 Gateway Property Audit 802 Returns the number of displays supported (integer value) and an IDs 803 for each display (integer value). 805 3.6.1.2 Termination Property Audit 807 Returns a display's parameters 808 nrows - integer: number of rows 809 ncols - integer: number of columns 810 cdpgs - string: list of supported Unicode code pages 811 cpos - current cursor position: row and column numbers 812 content - string: the current display content 814 Note: row and column numbering begin at 0. A display's origin is 815 row 0, column 0. 817 If a text display element supports more than the mandatory U+0000 -> 818 U+00ff symbol set, it shall respond to an Audit query of the 819 supported character sets by providing the high order octet plus the 820 high order bit of the lower octet of each supported character set. 822 For example, if the text display element supports U+2500 ->U+25ff, 823 U+2600 ->U+26ff and U+2700 -> U+277f, it would return "250, 258, 824 260, 268, 270" in cdpgs. 826 3.6.2. Events 828 3.6.2.1. Event Configuration 830 None. 832 3.6.2.2. Observed Event 834 None. 836 3.6.3. Signals 838 3.6.3.1. Display 839 Short name: disp 841 This is a text display signal. 843 Signal Parameters 845 row - integer 846 column - integer 847 str - string 848 attribute - string (OR of blink, invert, underline) 849 example: "attribute=invert" 850 example: "atribute=blink+underline" (OR'ing of 851 attributes) 853 Note 1: Text will be inserted beginning at the row and column given 854 in the signal parameters. If no row and column parameters are 855 given, the text will be inserted starting at the current cursor 856 position. The current cursor position will always be advanced to 857 the position immediately after the last character inserted. 859 Note 2: The attribute will apply to all characters contained in the 860 signal. If no attribute is provided, plain text will be displayed. 861 To turn on an attribute in the middle of a string, one would send a 862 signal with a beginning sub-string of plain text, follow by a signal 863 with the desired attribute(s) for the middle sub-string, and 864 finishing with the signal containing the remaining sub-string of 865 plain text. 867 Note 3: A string will not word wrap to the next row. If a string 868 cannot fit into the current row, it will be truncated without 869 warning. 871 3.6.3.2 Clear Display 873 Short name: clDisp 875 This signal clears the entire display and resets the current cursor 876 position to the origin (row 0, column 0). 878 Signal Parameters: 880 None. 882 3.6.4 Statistics 884 None. 886 3.7 Softkey Package 888 Short name: skey 890 Softkeys are a combination of a function key and a display element, 891 sharing some behavior of each. Softkeys are dynamically configured 892 by the MGC based on the current state and context of the application 893 controlling the IP Phone MG. 895 Softkey identifiers are indexed 1,2...N. N is the maximum number of 896 softkeys supported by a specific IP Phone MG. 898 3.7.1. Gateway Property Audit 900 Possible values: Returns a list of Softkeys 901 softKeyList = (numberOfSoftkeys, displaySize, supportedCharSet, 902 softkey *(,softkey)) 904 numberOfSoftkeys = integer 905 displaySize = integer ; number of characters 906 supportedCharSet = Unicode character sets supported 907 softkey = (nameStr, displayContent) 908 nameStr = character string 909 displayContent = Unicode character string 911 3.7.2. Events 913 3.7.2.1. Event Configuration 915 None. 917 3.7.2.2. Observed Events 919 3.7.2.2.1 Key Down 921 Short name: keyDown 923 Event Parameters: 925 softkeyId integer 926 nameStr 'C' string UTF-8 characters 928 3.7.2.2.2. Key Up 930 Short name: keyUp 932 Event Parameters 934 nameStr 'C' string UTF-8 characters 935 duration softkey press duration in milliseconds 936 3.7.3. Signals 938 3.7.3.1. Set Name 940 Softkey mapping command: 942 Short name: setName 944 Signal Parameters: 946 softkeyId integer 947 nameStr 'C' string, 8-bit UTF-8 encoding 949 Note: SetName with a null string clears the softkey, i.e. the 950 softkey becomes blank and inactive. 952 3.7.3.2. Display 954 Softkey control command that sets softkey display text. 956 Short name: display 958 Signal Parameters: 960 softkeyId integer 961 row integer 962 column integer 963 str 'C' string, 8-bit UTF-8 encoding 964 attribute OR of blink, invert (TBD) 966 {{Add nameStr parameter, to allow Display by SK name? Could also be 967 separate command, eg. DisplayByName(). Same issue as in Indicator. 968 }} 969 [[ Note: Should consider color (foreground and background) here. 970 Left for further study. ]] 972 3.7.4. Statistics 974 3.8 Trunk Generic 975 3.8.1 Trunk Generic Package 976 Short name: trunkgen 978 The Trunk Generic package groups non-specialised events and signals 979 for trunk lines. Those can be used with ISUP (ITU Q.764), TUP (ITU 980 Q.724) and CAS (e.g. R2:ITU Q.400 to Q.490). 981 3.8.2 Gateway Properties audit 982 3.8.3 Events 983 3.8.3.1 Event Configuration 984 3.8.3.1.1 Modem Detected 985 Short name: modem 986 Signals the detection of a modem signal on the termination. 988 Configuration Parameters: 990 streamid Id of the audio stream to perform the test on. 992 3.8.3.1.2 Fax Tone Detected 993 Short name: faxtone 994 Signals the detection of a fax tone on the termination. 996 Configuration Parameters: 998 streamid Id of the audio stream to perform the test on. 1000 3.8.3.1.3 Report Failure 1001 Short name: repfail 1003 Signals on the termination the detection of a failure due to 1004 external or internal (in the Media Gateway) reasons. 1006 Configuration Parameters: 1008 streamid Id of the audio stream to report failure on. 1010 3.8.3.2 Observed Events 1011 3.8.3.2.1 Modem Detected 1012 Short name: modem 1014 Event Parameters: 1016 none 1017 3.8.3.2.2 Fax Tone Detected 1019 Short name: faxtone 1021 Event Parameters: 1023 None 1025 3.8.3.2.3 Report Failure 1026 Short name: repfail 1028 Event Parameters: 1030 Error code 2 bytes describing the failure reason 1031 Default: 0000 (internal error) 1033 3.8.4 Signals 1034 3.8.4.1 Busy tone 1035 Short name: btone 1037 Play busy tone if the called side is busy as given in E.180. 1039 Signal Parameters: 1040 streamid id of the audio stream to play the signal on. 1042 3.8.4.2 Ringing Tone (timeout) 1043 Short name: ringing 1045 A tone advising the caller that a connection has been made and that 1046 a calling signal is being applied to a telephone number or service 1047 point. (See ITU Rec. E.180 and E.182) 1049 Signal Parameters: 1051 streamid id of the audio stream to play the signal on. 1052 Duration ringing tone duration in seconds 1054 3.8.4.3 Congestion Tone (timeout) 1055 Short name: congestion 1057 A tone advising the caller that the groups of lines or switching 1058 equipment necessary for the setting-up of the required call or for 1059 the use of a specific service are temporarily engaged. (See ITU Rec. 1060 E.180 and E.182) 1062 Signal Parameters: 1064 streamid id of the audio stream to play the signal on. 1065 duration timeout duration in seconds. 1067 3.8.5 Statistic 1068 3.8.5.1 Statistic Request 1069 none 1070 3.8.5.2 Statistic Report 1071 None 1073 -------------------------------------------------------------------- 1074 ------- 1075 3.9 Trunk Supplementary 1076 3.9.1 Trunk Supplementary Package 1078 Short name: trunksupp 1079 This package is used to handle events and signals on trunking 1080 terminations reaching the Media Gateway from the PSTN network. 1081 3.9.2 Gateway Properties audit 1083 3.9.3 Events 1084 3.9.3.1 Event Configuration 1085 3.9.3.1.1 Continuity Test 1087 Short name: conttest 1088 This event awaits the reception of the return tone, according to ITU 1089 G.724, in the process of a continuity test. 1091 Configuration Parameters: 1092 streamid Id of the audio stream to perform the test on. 1094 3.9.3.2 Observed Events 1095 3.9.3.2.1 Continuity Test 1097 Short name: conttest 1099 Event Parameters: 1100 Indication "SUCCESS", "NO SUCCESS" according to ITU 1101 Q.724/Q.764. 1103 3.9.4 Signals 1104 3.9.4.1 Continuity Tone (on/off) 1106 Short name: conttone 1107 Play a continuity tone as part of a requested continuity test as 1108 given in ITU Q.724. Both a single tone test and a dual tone test are 1109 supported. This signal should be used together with the conttest 1110 event. 1112 Signal Parameters: 1113 streamid id of the audio stream to perform the test on 1114 testtype "single" for single tone test 1115 "dual" for dual tone test 1116 3.9.5 Statistic 1117 3.9.5.1 Statistic Request 1118 none 1119 3.9.5.2 Statistic Report 1120 none 1122 -------------------------------------------------------------------- 1123 ------- 1125 3.10 NAS 1126 3.10.1 NAS Package 1127 Short name: nas 1129 This package supports the functionality of a Media Gateway as NAS 1130 (Network Access Server). This encompasses the support of dial-in 1131 access to the NAS, but not the contact to a AAA server for 1132 authentication, authorisation etc and the possible subsequent set-up 1133 of a layer 2 tunnel to a remote NAS. Those are autonomous functions 1134 of a NAS and therefore out of scope for the Megaco protocol (see 1135 e.g. IETF RFC 2661 (L2TP) and RFC 1661 (PPP)). 1136 3.10.2 Gateway Properties audit 1137 3.10.3 Events 1138 3.10.3.1 Event Configuration 1139 3.10.3.1.1 Report Failure 1140 Short name: repfail 1142 Signals on the termination the detection of a failure due to 1143 external or internal (in the Media Gateway) reasons. 1145 Configuration Parameters: 1147 streamid Id of the stream to report failure on. 1149 3.10.3.1.2 Authorisation succeeded 1151 Short name: authsucc 1153 This event signals that authorisation by the AAA server for the 1154 requested service was successful (see for example IETF RFC 2138 1155 (RADIUS)) 1157 Configuration Parameters: 1159 streamid Id of the stream to report on. 1161 3.10.3.1.3 Authorisation denied 1163 Short name: authden 1165 This event signals that authorisation by the AAA server for the 1166 requested service was denied (see for example IETF RFC 2138 1167 (RADIUS)) 1169 Configuration Parameters: 1171 streamid Id of the stream to report on. 1173 3.10.3.1.4 Call back Request 1175 Short name: cbr 1176 The call back event is used to notify that a call-back has been 1177 requested by the AAA server during the initial phase of a data 1178 connection (see IETF RFC 2138 (RADIUS)). The event report includes 1179 the identification of the user to be called back, e.g. E.164 number. 1181 Configuration Parameters: 1183 streamid Id of the stream on which to look for the request. 1185 3.10.3.1.5 Authentication Authorisation and Accounting (AAA) Failure 1187 Short name: aaafail 1189 Used to signal failure of the AAA server. 1191 Configuration Parameters: 1193 streamid Id of the stream to check for failure. 1195 3.10.3.2 Observed Events 1196 3.10.3.2.1 Report Failure 1197 Short name: repfail 1199 Event Parameters: 1201 Error code 2 bytes describing the failure reason 1202 Default: 0000 (internal error) 1203 3.10.3.2.2 Authorisation succeeded 1205 Short name: authsucc 1207 Event Parameters: 1208 none 1209 3.10.3.2.3 Authorisation denied 1211 Short name: authden 1213 Event Parameters: 1214 none 1215 3.10.3.2.4 Authentication Authorization and Accounting (AAA) Failure 1217 Short name: aaafail 1219 Event Parameters: 1220 Error code 2 bytes describing the failure reason 1221 Default: 0000 (internal error) 1222 3.10.4 Signals 1223 3.10.5 Statistic 1224 3.10.5.1 Statistic Request 1225 none 1226 3.10.5.2 Statistic Report 1227 none 1229 -------------------------------------------------------------------- 1230 ------- 1231 3.11 RTP 1232 3.11.1 RTP Package 1233 Short name: rtp 1235 This package is used to support packet based multimedia data 1236 transfer by means of the Real-time Transport Protocol (RTP). 1237 3.11.2 Gateway Properties audit 1238 3.11.2.1 Timestamps 1239 Short name: timest 1241 Describes the time units. 1243 Possible values: 1244 milliseconds 1245 minutes 1247 3.11.3 Events 1248 3.11.3.1 Event Configuration 1249 3.11.3.1.1 Report Failure 1250 Short name: repfail 1252 Signals on the termination the detection of a failure due to 1253 external or internal (in the Media Gateway) reasons. 1255 Configuration Parameters: 1257 streamid Id of the audio stream to report failure on. 1259 3.11.3.1.2 Quality Alert 1260 Short name: qualert 1262 Alerts the MGC in case jitter, delay or the rate of packet loss 1263 exceed given threshold values. See IETF RFC 1889 for a definition of 1264 those terms. 1266 Configuration Parameters: 1267 streamid Id of the audio stream to perform the test on. 1269 packet loss packet loss threshold value (as percentage) 1270 jitter jitter threshold value in timestamp units. 1271 delay packet propagation delay measured in timestamp 1272 units. 1273 3.11.3.2 Observed Events 1274 3.11.3.2.1 Report Failure 1275 Short name: repfail 1277 Event Parameters: 1279 Error code 2 bytes describing the failure reason 1280 Default: 0000 (internal error) 1282 3.11.3.2.2 Quality Alert 1284 Short name: qualert 1286 Event Parameters: 1287 packet loss measured value of packet loss (as percentage) 1288 jitter measured interarrival jitter (in timestamp 1289 units) 1290 delay packet propagation delay measured in timestamp 1291 units. 1292 3.11.4 Signals 1294 3.11.5 Statistic 1295 3.11.5.1 Statistic Request 1296 3.11.5.1.1 Packet Loss 1298 Short name: pl 1300 Describes the current rate of packet loss on an RTP stream, as 1301 defined in IETF RFC 1889. Packet loss is expressed as percentage 1302 value: number of packets lost in the interval between two reception 1303 reports, divided by the number of packets expected during that 1304 interval. 1306 Request parameters: RTP stream ID. 1307 3.11.5.1.2 Jitter 1309 Short name: jitter 1311 Requests the current value of the interarrival jitter on an RTP 1312 stream as defined in IETF RFC 1889. Jitter measures the variation in 1313 interarrival time for RTP data packets. 1315 Request parameters: RTP stream ID. 1317 3.11.5.1.3 Delay 1319 Short name: delay 1321 Requests the current value of packet propagation delay expressed in 1322 timestamp units. 1324 Request parameters: RTP stream ID. 1326 3.11.5.2 Statistic Report 1327 3.11.5.2.1 Packet Loss 1329 Short name: pl 1331 Possible values: percentage value of packets lost on this stream. 1333 3.11.5.2.2 Jitter 1335 Short name: jitter 1337 Possible values: interarrival jitter measured in timestamp units. 1339 3.11.5.2.3 Delay 1341 Short name: delay 1343 Possible values: packet propagation delay measured in timestamp 1344 units. 1346 -------------------------------------------------------------------- 1347 ------- 1348 3.12 Anouncement 1349 3.12.1 Announcement Server Package 1351 Short name: ann 1353 This package supports announcement functionality at a Media Gateway. 1354 3.12.2 Gateway Properties audit 1355 3.12.3 Events 1356 3.12.3.1 Event Configuration 1357 3.12.3.1.1 Announcement completed 1359 Short name: anncomp 1360 3.12.3.1.2 Announcement Failure 1362 Short name: annfail 1364 Configuration Parameters: 1366 streamid Id of the concerned audio stream. 1368 3.12.3.2 Observed Events 1369 3.12.3.2.1 Announcement Failure 1371 Short name: annfail 1372 Event Parameters: 1373 Error code 2 bytes describing the failure reason 1374 Default: 0000 (internal error) 1375 3.12.3.2.2 Announcement completed 1377 Short name: anncomp 1379 3.12.4 Signals 1380 3.12.4.1 Announcement Play 1382 Short name: annplay 1383 Play an announcement 1385 Signal Parameters: 1386 streamId id of the audio stream to play an announcement on 1387 type choice from an announcement list 1388 params announcement parameters (e.g. specific 1389 numbers) 1391 3.12.5 Statistic 1392 3.12.5.1 Statistic Request 1393 none 1394 3.12.5.2 Statistic Report 1395 none 1397 4. References 1399 [] CCITT Recommendation E.180/Q.35 Technical characteristics of 1400 tones for the telephone service (03/98) 1401 []CCITT Recommendation E.182 Application of tones and recorded 1402 announcements in telephone services (03/98) 1403 []CCITT Recommendation Q.724 (1988). Telephone User Part Signalling 1404 Procedures 1405 []CCITT Recommendation Q.764 (1988). Signalling System No.7 ISDN 1406 User Part Signalling Procedures 1407 []CCITT Recommendation Q.115 (06/97) Logic for the control of echo 1408 control devices 1409 []CCITT Recommendations Q.400 to Q.490 (1988), Specifications of 1410 Signalling System R2. 1411 [] IETF RFC 1661: Simpson, W., The Point-to-Point Protocol (PPP), 1412 July 1994 1413 [] IETF RFC 1889: Schulzrinne, H., et al, RTP: A Transport Protocol 1414 for Real-Time Applications, January 1996 1415 [] IETF RFC 2138: Rigney, C., et al, Remote Authentication Dial In 1416 Service (RADIUS), April 1997 1417 []IETF RFC 2661: Townsley, W., et al, Layer Two Tunneling Protocol 1418 "L2TP", August 1999 1420 5. Author's Addresses 1422 1423 1424 Nortel Networks 1425 P.O. Box 833805 1426 Richardson, Texas 75083-3805 1427 USA 1429 Email: 1431 Zacharias Bilalis(editor) 1432 Siemens 1433 Email: zacharias.bilalis@icn.siemens.de 1435 Full Copyright Statement 1437 "Copyright (C) The Internet Society (date). All Rights Reserved. 1438 This document and translations of it may be copied and furnished to 1439 others, and derivative works that comment on or otherwise explain it 1440 or assist in its implmentation may be prepared, copied, published 1441 and distributed, in whole or in part, without restriction of any 1442 kind, provided that the above copyright notice and this paragraph 1443 are included on all such copies and derivative works. However, this 1444 document itself may not be modified in any way, such as by removing 1445 the copyright notice or references to the Internet Society or other 1446 Internet organizations, except as needed for the purpose of 1447 developing Internet standards in which case the procedures for 1448 copyrights defined in the Internet Standards process must be 1449 followed, or as required to translate it into