JBoss.orgCommunity Documentation

Chapter 4.  Capabilities of JBoss Communications Media Server

4.1. Announcement Endpoint
4.2. IVR Endpoint
4.3. Conference Endpoint
4.4. PacketRelay Endpoint

Each endpoint supports specific MGCP Packages and some or all of the Events/Signals defined in that package. Bellow table shows the capabilities of each endpoints defined in MMS

The Announcement Endpoint is identified by localname /mobicents/media/aap/[1..10] where number in square brackets indicates the range of endpoints configured and started by media server.

The MGCP Packages and corresponding Signals/Events supported by Announcement Endpoint is specified in bellow table. Line in italics is MGCP Signal Request/Signal Event Example

Table 4.1.  Packages and corresponding Signals/Events supported by Announcement Endpoint
Supported Package
Announcement (A) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

The PlayAnnouncement Signal must be qualified by a String of Parameter(s). If Play Announcemnet is not provided with a parameter specifying some form of playable audio or Text-to-Speech text an error is returned to application.

The Play Announcement takes the URL of the media file to be played as parameter. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav

    S:A/ann@1(http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav)

  • On local server where media server is hosted file:/home/mobicents/RQNT-ULAW.wav

    S:A/ann@1(file:/home/mobicents/RQNT-ULAW.wav)

  • In addition URL of txt file can also be passed and media server would play that text file as TTS with default voice. For ex http://ann.example.net/hello.txt or file:/home/mobicents/hello.txt

  • Segment descriptor can also be used with the ann signal to make up an announcement. The only supported Segment descriptor is 'ts'. 'ts' Specifies a text string to be converted to speech. Optionally voice name 'vc' can also be passed to direct media server to play this speech in given voice. For example ts("Your text here") vc("mbrola_us1")

    For supported voices look at Table 2.1, “Directory Structure”

    S:A/ann@6(ts(You have pressed One) vc(Mbrola_US1))

  • The relative path of audio/txt file can also be passed for example RQNT-ULAW.wav

    In this case MMS will try to serach the corresponding file in ${mms.media.dir} folder.

Advance Announcement (AU) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

Same as Announcement Package's Play Announcement Signal

Record (aupr)

The Record Signal must be qualified by a String of Parameter. If Record is not provided with a parameter specifying path (absolute or relative) and name of audio file, error is returned to application.

The URL can be absolute URL or relative in which case recorded file will be placed at ${mms.media.dir} folder. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav

    S:AU/aupr@1(http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav)

  • On local server where media server is hosted file:/home/mobicents/recorded.wav

    S:AU/aupr@1(file:/home/mobicents/recorded.wav)

  • The relative path of file can also be passed for example recorded.wav

    In this case MMS will create recorded.wav in ${mms.media.dir} folder.

DTMF (D) : Supported Events Parameters
dtmf0

NA

O: D/dtmf0@1

dtmf1

NA

O: D/dtmf1@1

dtmf2

NA

O: D/dtmf2@1

dtmf3

NA

O: D/dtmf3@1

dtmf4

NA

O: D/dtmf4@1

dtmf5

NA

O: D/dtmf5@1

dtmf6

NA

O: D/dtmf6@1

dtmf7

NA

O: D/dtmf7@1

dtmf8

NA

O: D/dtmf8@1

dtmf9

NA

O: D/dtmf9@1

dtmfA

NA

O: D/dtmfA@1

dtmfB

NA

O: D/dtmfB@1

dtmfC

NA

O: D/dtmfC@1

dtmfD

NA

O: D/dtmfD@1

dtmfHash

NA

O: D/dtmfHash@1

dtmfStar

NA

O: D/dtmfStar@1

Supported Signals Parameters
dtmf0

NA

S:D/dtmf0@1

dtmf1

NA

S:D/dtmf1@1

dtmf2

NA

S:D/dtmf2@1

dtmf3

NA

S:D/dtmf3@1

dtmf4

NA

S:D/dtmf4@1

dtmf5

NA

S:D/dtmf5@1

dtmf6

NA

S:D/dtmf6@1

dtmf7

NA

S:D/dtmf7@1

dtmf8

NA

S:D/dtmf8@1

dtmf9

NA

S:D/dtmf9@1

dtmfA

NA

S:D/dtmfA@1

dtmfB

NA

S:D/dtmfB@1

dtmfC

NA

S:D/dtmfC@1

dtmfD

NA

S:D/dtmfD@1

dtmfHash

NA

S:D/dtmfHash@1

dtmfStar

NA

S:D/dtmfStar@1

The IVR Endpoint is identified by localname /mobicents/media/IVR/[1..10] where number in square brackets indicates the range of endpoints configured and started by media server.

The MGCP Packages and corresponding Signals/Events supported by IVR Endpoint is specified in bellow table. Line in italics is MGCP Signal Request/Signal Event Example

Table 4.2.  Packages and corresponding Signals/Events supported by IVR Endpoint
Supported Package
Announcement (A) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

The PlayAnnouncement Signal must be qualified by a String of Parameter(s). If Play Announcemnet is not provided with a parameter specifying some form of playable audio or Text-to-Speech text an error is returned to application.

The Play Announcement takes the URL of the media file to be played as parameter. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav

    S:A/ann@1(http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav)

  • On local server where media server is hosted file:/home/mobicents/RQNT-ULAW.wav

    S:A/ann@1(file:/home/mobicents/RQNT-ULAW.wav)

  • In addition URL of txt file can also be passed and media server would play that text file as TTS with default voice. For ex http://ann.example.net/hello.txt or file:/home/mobicents/hello.txt

  • Segment descriptor can also be used with the ann signal to make up an announcement. The only supported Segment descriptor is 'ts'. 'ts' Specifies a text string to be converted to speech. Optionally voice name 'vc' can also be passed to direct media server to play this speech in given voice. For example ts("Your text here") vc("mbrola_us1")

    For supported voices look at Table 2.1, “Directory Structure”

    S:A/ann@6(ts(You have pressed One) vc(Mbrola_US1))

  • The relative path of audio/txt file can also be passed for example RQNT-ULAW.wav

    In this case MMS will try to serach the corresponding file in ${mms.media.dir} folder.

Advance Announcement (AU) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

Same as Announcement Package's Play Announcement Signal

Record (aupr)

The Record Signal must be qualified by a String of Parameter. If Record is not provided with a parameter specifying path (absolute or relative) and name of audio file, error is returned to application.

The URL can be absolute URL or relative in which case recorded file will be placed at ${mms.media.dir} folder. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav

    S:AU/aupr@1(http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav)

  • On local server where media server is hosted file:/home/mobicents/recorded.wav

    S:AU/aupr@1(file:/home/mobicents/recorded.wav)

  • The relative path of file can also be passed for example recorded.wav

    In this case MMS will create recorded.wav in ${mms.media.dir} folder.

DTMF (D) : Supported Events Parameters
dtmf0

NA

O: D/dtmf0@1

dtmf1

NA

O: D/dtmf1@1

dtmf2

NA

O: D/dtmf2@1

dtmf3

NA

O: D/dtmf3@1

dtmf4

NA

O: D/dtmf4@1

dtmf5

NA

O: D/dtmf5@1

dtmf6

NA

O: D/dtmf6@1

dtmf7

NA

O: D/dtmf7@1

dtmf8

NA

O: D/dtmf8@1

dtmf9

NA

O: D/dtmf9@1

dtmfA

NA

O: D/dtmfA@1

dtmfB

NA

O: D/dtmfB@1

dtmfC

NA

O: D/dtmfC@1

dtmfD

NA

O: D/dtmfD@1

dtmfHash

NA

O: D/dtmfHash@1

dtmfStar

NA

O: D/dtmfStar@1

Supported Signals Parameters
dtmf0

NA

S:D/dtmf0@1

dtmf1

NA

S:D/dtmf1@1

dtmf2

NA

S:D/dtmf2@1

dtmf3

NA

S:D/dtmf3@1

dtmf4

NA

S:D/dtmf4@1

dtmf5

NA

S:D/dtmf5@1

dtmf6

NA

S:D/dtmf6@1

dtmf7

NA

S:D/dtmf7@1

dtmf8

NA

S:D/dtmf8@1

dtmf9

NA

S:D/dtmf9@1

dtmfA

NA

S:D/dtmfA@1

dtmfB

NA

S:D/dtmfB@1

dtmfC

NA

S:D/dtmfC@1

dtmfD

NA

S:D/dtmfD@1

dtmfHash

NA

S:D/dtmfHash@1

dtmfStar

NA

S:D/dtmfStar@1

The Conference Endpoint is identified by localname /mobicents/media/cnf/[1..60] where number in square brackets indicates the range of endpoints configured and started by media server.

The MGCP Packages and corresponding Signals/Events supported by Conference Endpoint is specified in bellow table. Line in italics is MGCP Signal Request/Signal Event Example

Table 4.3.  Packages and corresponding Signals/Events supported by Conference Endpoint
Supported Package
Announcement (A) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

The PlayAnnouncement Signal must be qualified by a String of Parameter(s). If Play Announcemnet is not provided with a parameter specifying some form of playable audio or Text-to-Speech text an error is returned to application.

The Play Announcement takes the URL of the media file to be played as parameter. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav

    S:A/ann@1(http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav)

  • On local server where media server is hosted file:/home/mobicents/RQNT-ULAW.wav

    S:A/ann@1(file:/home/mobicents/RQNT-ULAW.wav)

  • In addition URL of txt file can also be passed and media server would play that text file as TTS with default voice. For ex http://ann.example.net/hello.txt or file:/home/mobicents/hello.txt

  • Segment descriptor can also be used with the ann signal to make up an announcement. The only supported Segment descriptor is 'ts'. 'ts' Specifies a text string to be converted to speech. Optionally voice name 'vc' can also be passed to direct media server to play this speech in given voice. For example ts("Your text here") vc("mbrola_us1")

    For supported voices look at Table 2.1, “Directory Structure”

    S:A/ann@6(ts(You have pressed One) vc(Mbrola_US1))

  • The relative path of audio/txt file can also be passed for example RQNT-ULAW.wav

    In this case MMS will try to serach the corresponding file in ${mms.media.dir} folder.

Advance Announcement (AU) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

Same as Announcement Package's Play Announcement Signal

Record (aupr)

The Record Signal must be qualified by a String of Parameter. If Record is not provided with a parameter specifying path (absolute or relative) and name of audio file, error is returned to application.

The URL can be absolute URL or relative in which case recorded file will be placed at ${mms.media.dir} folder. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav

    S:AU/aupr@1(http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav)

  • On local server where media server is hosted file:/home/mobicents/recorded.wav

    S:AU/aupr@1(file:/home/mobicents/recorded.wav)

  • The relative path of file can also be passed for example recorded.wav

    In this case MMS will create recorded.wav in ${mms.media.dir} folder.

DTMF (D) : Supported Events Parameters
dtmf0

NA

O: D/dtmf0@1

dtmf1

NA

O: D/dtmf1@1

dtmf2

NA

O: D/dtmf2@1

dtmf3

NA

O: D/dtmf3@1

dtmf4

NA

O: D/dtmf4@1

dtmf5

NA

O: D/dtmf5@1

dtmf6

NA

O: D/dtmf6@1

dtmf7

NA

O: D/dtmf7@1

dtmf8

NA

O: D/dtmf8@1

dtmf9

NA

O: D/dtmf9@1

dtmfA

NA

O: D/dtmfA@1

dtmfB

NA

O: D/dtmfB@1

dtmfC

NA

O: D/dtmfC@1

dtmfD

NA

O: D/dtmfD@1

dtmfHash

NA

O: D/dtmfHash@1

dtmfStar

NA

O: D/dtmfStar@1

Supported Signals Parameters
dtmf0

NA

S:D/dtmf0@1

dtmf1

NA

S:D/dtmf1@1

dtmf2

NA

S:D/dtmf2@1

dtmf3

NA

S:D/dtmf3@1

dtmf4

NA

S:D/dtmf4@1

dtmf5

NA

S:D/dtmf5@1

dtmf6

NA

S:D/dtmf6@1

dtmf7

NA

S:D/dtmf7@1

dtmf8

NA

S:D/dtmf8@1

dtmf9

NA

S:D/dtmf9@1

dtmfA

NA

S:D/dtmfA@1

dtmfB

NA

S:D/dtmfB@1

dtmfC

NA

S:D/dtmfC@1

dtmfD

NA

S:D/dtmfD@1

dtmfHash

NA

S:D/dtmfHash@1

dtmfStar

NA

S:D/dtmfStar@1

The PacketRelay Endpoint is identified by localname /mobicents/media/packetrelay/[1..10] where number in square brackets indicates the range of endpoints configured and started by media server.

The MGCP Packages and corresponding Signals/Events supported by PacketRelay Endpoint is specified in bellow table. Line in italics is MGCP Signal Request/Signal Event Example

Table 4.4.  Packages and corresponding Signals/Events supported by PacketRelay Endpoint
Supported Package
Announcement (A) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

The PlayAnnouncement Signal must be qualified by a String of Parameter(s). If Play Announcemnet is not provided with a parameter specifying some form of playable audio or Text-to-Speech text an error is returned to application.

The Play Announcement takes the URL of the media file to be played as parameter. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav

    S:A/ann@1(http://127.0.0.1:8080/mgcpdemo/audio/RQNT-ULAW.wav)

  • On local server where media server is hosted file:/home/mobicents/RQNT-ULAW.wav

    S:A/ann@1(file:/home/mobicents/RQNT-ULAW.wav)

  • In addition URL of txt file can also be passed and media server would play that text file as TTS with default voice. For ex http://ann.example.net/hello.txt or file:/home/mobicents/hello.txt

  • Segment descriptor can also be used with the ann signal to make up an announcement. The only supported Segment descriptor is 'ts'. 'ts' Specifies a text string to be converted to speech. Optionally voice name 'vc' can also be passed to direct media server to play this speech in given voice. For example ts("Your text here") vc("mbrola_us1")

    For supported voices look at Table 2.1, “Directory Structure”

    S:A/ann@6(ts(You have pressed One) vc(Mbrola_US1))

  • The relative path of audio/txt file can also be passed for example RQNT-ULAW.wav

    In this case MMS will try to serach the corresponding file in ${mms.media.dir} folder.

Advance Announcement (AU) Supported Events Parameters
OperationComplete (oc)

NA

O: A/oc@1

OperationFailure (of)

NA

O: A/of@1

Supported Signals Parameters
Play Announcement (ann)

Same as Announcement Package's Play Announcement Signal

Record (aupr)

The Record Signal must be qualified by a String of Parameter. If Record is not provided with a parameter specifying path (absolute or relative) and name of audio file, error is returned to application.

The URL can be absolute URL or relative in which case recorded file will be placed at ${mms.media.dir} folder. The examples are

  • On remote server http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav

    S:AU/aupr@1(http://127.0.0.1:8080/mgcpdemo/audio/recorded.wav)

  • On local server where media server is hosted file:/home/mobicents/recorded.wav

    S:AU/aupr@1(file:/home/mobicents/recorded.wav)

  • The relative path of file can also be passed for example recorded.wav

    In this case MMS will create recorded.wav in ${mms.media.dir} folder.

DTMF (D) : Supported Events Parameters
dtmf0

NA

O: D/dtmf0@1

dtmf1

NA

O: D/dtmf1@1

dtmf2

NA

O: D/dtmf2@1

dtmf3

NA

O: D/dtmf3@1

dtmf4

NA

O: D/dtmf4@1

dtmf5

NA

O: D/dtmf5@1

dtmf6

NA

O: D/dtmf6@1

dtmf7

NA

O: D/dtmf7@1

dtmf8

NA

O: D/dtmf8@1

dtmf9

NA

O: D/dtmf9@1

dtmfA

NA

O: D/dtmfA@1

dtmfB

NA

O: D/dtmfB@1

dtmfC

NA

O: D/dtmfC@1

dtmfD

NA

O: D/dtmfD@1

dtmfHash

NA

O: D/dtmfHash@1

dtmfStar

NA

O: D/dtmfStar@1

Supported Signals Parameters
dtmf0

NA

S:D/dtmf0@1

dtmf1

NA

S:D/dtmf1@1

dtmf2

NA

S:D/dtmf2@1

dtmf3

NA

S:D/dtmf3@1

dtmf4

NA

S:D/dtmf4@1

dtmf5

NA

S:D/dtmf5@1

dtmf6

NA

S:D/dtmf6@1

dtmf7

NA

S:D/dtmf7@1

dtmf8

NA

S:D/dtmf8@1

dtmf9

NA

S:D/dtmf9@1

dtmfA

NA

S:D/dtmfA@1

dtmfB

NA

S:D/dtmfB@1

dtmfC

NA

S:D/dtmfC@1

dtmfD

NA

S:D/dtmfD@1

dtmfHash

NA

S:D/dtmfHash@1

dtmfStar

NA

S:D/dtmfStar@1