Version

Appendix C

MGCP Endpoint Parameters

: MGCP Service Endpoint Parameters
: MGCP Event and Signal Request Parameters

MGCP Service Endpoint Parameters

When registering endpoints with mgcRegisterEndpoint, applications provide a pointer to the following structure:

typedef struct { DWORD size; MGC_ENDPOINT_TYPE type; char dfltpackage[64]; INT32 supportedmodes; char suppackages[1024]; char appevents[1024]; char notifiedentity[256]; CTAHD ctahd; CTAHD ctahdivr; } MGC_ENDPOINT_PARMS;
The MGC_ENDPOINT_PARMS structure specifies how MGCP service endpoints operate in response to commands from call agents. size Type DWORD Units Bytes. Default Value Not applicable. Allowed Values Not applicable. Description Indicates the size of the MGC_ENDPOINT_PARMS structure.
type

Type

DWORD

Units

Not applicable.

Default Value

Not applicable.

Allowed Values

The following constants are defined for specific endpoint types:
Constant EndPoint Type
MGC_ENDPOINT_TYPE_DS0 DS0 endpoint
MGC_ENDPOINT_TYPE_IVR IVR endpoint
MGC_ENDPOINT_TYPE_ANNOUNCE Announcement server endpoint

Description

Specifies type of the endpoint that the MGCP service creates.

dfltpackage[64]

Type

char

Units

Not applicable.

Default Value

Not applicable.

Allowed Values

Endpoints registered with the MGCP service can support any of the following basic packages as defined in RFC 2705:
Package Name Description
G Generic media package
D DTMF package
M MF package
T Trunk package
L Line package
R RTP package
A Announcement server package
Any defined extension package.

Description

Specifies the default package that the endpoint supports.
When call agents make requests, typically they specify signal or event that they want the endpoint to execute, along with the name of the package to which the signal or event belongs. When the endpoint defines a default package, call agent requests can omit the package name from requests associated with that package.

supportedmodes

Type

INT32

Units

Not applicable.

Default Value

Not applicable.

Allowed Values

The following constants define specific endpoint modes:
Constant Description
MGC_MODE_SENDONLY The endpoint only sends data.
MGC_MODE_RECVONLY The endpoint only receives data.
MGC_MODE_SENDRECV The endpoint sends and receives data.
MGC_MODE_INACTIVE The endpoint remains inactive until
otherwise indicated.
MGC_MODE_LOOPBACK The endpoint returns incoming signals
received from an endpoint back to the
endpoint.
MGC_MODE_CONTTEST The endpoint places the circuit in the
transponder mode required for dual-tone
continuity tests.
MGC_MODE_NETWLOOP The audio signals received from a
connection are echoed back on the same
connection.

Description

Specifies transmission mode(s) supported by the endpoint.
Note: Multiple values can be combined with the OR function.

suppackages[1024]

Type

char

Units

Not applicable.

Default Value

Value set with dfltpackage.

Allowed Values

The MGCP packages to that the endpoint supports. These can include one or more of the following:
Package Name Description
G Generic media package
D DTMF package
M MF package
T Trunk package
L Line package
R RTP package
A Announcement server package

Description

Lists the packages that the endpoint supports. This list can include extension packages defined with mgcDefinePackage.

appevents[1024]

Type

char

Units

Not applicable.

Default Value

Not applicable.

Allowed Values

List of events to which the application that created the endpoint responds. Applications can specify the full set of events associated with the package in accordance with the MGCP specification.

Description

Lists the events that endpoint returns to the application.

notifiedentity[256]

Type

char

Units

Not applicable.

Default Value

Not applicable.

Allowed Values

Domain name of the call agent that controls the endpoint when it is initialized.

Description

Specifies the current default call agent for the endpoint. The endpoint still accept requests (and send associated messages) from other call agents.
The call agent specified by this parameter may change the notifiedentity value to point to another call agent (for example, if the default call agent is going out of service).
ctahd Type CTAHD Units Not applicable. Default Value Not applicable. Allowed Values Valid handle on which to open the MSPP service. Note: For IVR endpoints, the application must also open the ADI service on this handle. Description Specifies a handle to associate with this endpoint.
ctahdivr Type CTAHD Units Not applicable Default Value Not applicable. Allowed Values Valid context handle. Description When the endpoint is an IVR endpoint, the context handle for the IVR DSP. Note: If the endpoint is not an IVR endpoint, this value should be NULL.

size
Type	DWORD
Units	Bytes.
Default Value	Not applicable.
Allowed Values	Not applicable.
Description	Indicates the size of the MGC_ENDPOINT_PARMS structure.

type
Type	DWORD
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	The following constants are defined for specific endpoint types: Constant EndPoint Type MGC_ENDPOINT_TYPE_DS0 DS0 endpoint MGC_ENDPOINT_TYPE_IVR IVR endpoint MGC_ENDPOINT_TYPE_ANNOUNCE Announcement server endpoint
Description	Specifies type of the endpoint that the MGCP service creates.

dfltpackage[64]
Type	char
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	Endpoints registered with the MGCP service can support any of the following basic packages as defined in RFC 2705: Package Name Description G Generic media package D DTMF package M MF package T Trunk package L Line package R RTP package A Announcement server package Any defined extension package.
Description	Specifies the default package that the endpoint supports. When call agents make requests, typically they specify signal or event that they want the endpoint to execute, along with the name of the package to which the signal or event belongs. When the endpoint defines a default package, call agent requests can omit the package name from requests associated with that package.

supportedmodes
Type	INT32
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	The following constants define specific endpoint modes: Constant Description MGC_MODE_SENDONLY The endpoint only sends data. MGC_MODE_RECVONLY The endpoint only receives data. MGC_MODE_SENDRECV The endpoint sends and receives data. MGC_MODE_INACTIVE The endpoint remains inactive until otherwise indicated. MGC_MODE_LOOPBACK The endpoint returns incoming signals received from an endpoint back to the endpoint. MGC_MODE_CONTTEST The endpoint places the circuit in the transponder mode required for dual-tone continuity tests. MGC_MODE_NETWLOOP The audio signals received from a connection are echoed back on the same connection.
Description	Specifies transmission mode(s) supported by the endpoint. Note: Multiple values can be combined with the OR function.

suppackages[1024]
Type	char
Units	Not applicable.
Default Value	Value set with dfltpackage.
Allowed Values	The MGCP packages to that the endpoint supports. These can include one or more of the following: Package Name Description G Generic media package D DTMF package M MF package T Trunk package L Line package R RTP package A Announcement server package
Description	Lists the packages that the endpoint supports. This list can include extension packages defined with mgcDefinePackage.

appevents[1024]
Type	char
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	List of events to which the application that created the endpoint responds. Applications can specify the full set of events associated with the package in accordance with the MGCP specification.
Description	Lists the events that endpoint returns to the application.

notifiedentity[256]
Type	char
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	Domain name of the call agent that controls the endpoint when it is initialized.
Description	Specifies the current default call agent for the endpoint. The endpoint still accept requests (and send associated messages) from other call agents. The call agent specified by this parameter may change the notifiedentity value to point to another call agent (for example, if the default call agent is going out of service).

ctahd
Type	CTAHD
Units	Not applicable.
Default Value	Not applicable.
Allowed Values	Valid handle on which to open the MSPP service. Note: For IVR endpoints, the application must also open the ADI service on this handle.
Description	Specifies a handle to associate with this endpoint.

ctahdivr
Type	CTAHD
Units	Not applicable
Default Value	Not applicable.
Allowed Values	Valid context handle.
Description	When the endpoint is an IVR endpoint, the context handle for the IVR DSP. Note: If the endpoint is not an IVR endpoint, this value should be NULL.

MGCP Event and Signal Request Parameters

For endpoints that support extension packages or endpoint that override specific signals or events in packages that the MGCP service supports by default, the application can receive the following events when a call agent makes a request: MGCEVN_EVENT_SIGNAL_ON_REQUEST MGCEVN_EVENT_SIGNAL_OFF_REQUEST MGCEVN_EVENT_EVENT_ON_REQUEST MGCEVN_EVENT_EVENT_OFF_REQUEST
Each of these events includes a buffered structure that includes the following information:

Field

Type

Units

Description

requestid

int

Not applicable

Request ID assigned by the MGCP service when it received the request from the call agent.

EPName [128]

char

Not applicable

Endpoint name specified with mgcRegisterEndpoint.

PackageName[128]

char

Not applicable

Name of the package associated with the signal or event. NULL if the signal or event request is associated with the endpoint's default package.

EventName[128]

char

Not applicable

Name of the signal or event that the call agent is requesting.

EventParms[128]

char

Not applicable

Any additional parameters associated with the signal or event.

Field	Type	Units	Description
requestid	int	Not applicable	Request ID assigned by the MGCP service when it received the request from the call agent.
EPName [128]	char	Not applicable	Endpoint name specified with mgcRegisterEndpoint.
PackageName[128]	char	Not applicable	Name of the package associated with the signal or event. NULL if the signal or event request is associated with the endpoint's default package.
EventName[128]	char	Not applicable	Name of the signal or event that the call agent is requesting.
EventParms[128]	char	Not applicable	Any additional parameters associated with the signal or event.

Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com