Call Notification
Enables VidyoGateway to convey to the external application the details of an incoming call and to receive a response with either a new dial string or an indication to reject the call (as an invalid dial string or as room not accessible).
This method can use the following parameters.
Request parameters
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
dialString |
String |
Dial string that was dialed (extension and PIN, if available) |
Yes |
|
sourceIP |
String |
IP address that the call is coming from |
Yes |
|
clusterIP |
String |
IP address of the VidyoGateway cluster controller that is accepting the call |
Yes |
|
userAgent |
String |
Type of device used for making the call |
Optional |
|
from |
String |
Name of the caller |
Optional |
|
protocol |
String |
H.323 or SIP |
Yes |
Response parameter
|
Name |
Type |
Description |
Required |
|---|---|---|---|
|
newDialString |
String |
Extension for the VidyoGateway to call |
No |
Faults
|
Name |
Description |
|---|---|
|
Error:404 |
Dial string is invalid. The VidyoGateway will play the “Retry Conference Error” IVR prompt. |
|
Error:425 |
Room not accessible (locked/full). The VidyoGateway will play the “Retry Room Not Accessible” IVR prompt. |
|
General Error |
When the external application returns a different response (not 200, 404, or 425), the VidyoGateway IVR will play the “Retry Room Generic Error” IVR prompt. |