Client
Client
Noun Attributes
The <Client> noun supports the following attributes that modify its behavior:
| Attribute Name | Allowed Values | Default Value | Description |
|---|---|---|---|
url |
any url |
none |
call screening url |
timeout |
positive integer in seconds |
60 seconds |
call screening timeout |
method |
|
|
method for call screening url |
statusCallbackEvent |
|
initiated, ringing, answered ,completed |
Event triggers for status callback |
statusCallback |
any url |
none |
statusCallback url |
statusCallbackMethod |
|
|
method for statusCallback url |
url
The 'url' attribute lets you specify a url for a RCML document that will run on the called party’s end, after they answer, but before the both parties are connected. You can use this RCML to privately Play or Say information to the called party, or provide a chance to decline the phone call using <Gather> and <Hangup>. The caller will continue to hear ringing while the RCML document executes on the other end. RCML documents executed in this manner are not allowed to contain the <Dial> verb.
timeout
The 'timeout' allows you to specify the limit in seconds that call screening waits for the called party to accept the call. Default value 60 seconds
method
The 'method' attribute allows you to specify which HTTP method Restcomm should use when requesting the URL in the 'url' attribute. The default is POST.
statusCallbackEvent
When dialing out to a Client using <Dial>, an outbound call is initiated. The call transitions from the initiated state to the ringing state when the phone starts ringing. It transitions to the answered state when the call is picked up, and finally to the completed state when the call is over. With statusCallbackEvent, you can subscribe to receive webhooks for the different call progress events: initiated, ringing, answered, or completed for a given call.
The statusCallbackEvent attribute allows you to specify which events CPaaS should webhook on. You can specify multiple events by separating them with a comma: initiated,ringing,answered,completed. If a statusCallback is provided and no status callback events are specified then all of the events will be triggered by default.
As opposed to creating an outbound call via the API, outbound calls created using <Dial> are initiated right away and never queued. The following shows a timeline of possible call events that can be returned and the different call statuses that a <Dial> leg may experience:
The <Client> noun specifies a client identifier to dial. You can use multiple <Client> nouns within a <Dial> verb to simultaneously attempt a call with many clients at once. The first client to accept the incoming call is connected to the call, while the rest of the call attempts are canceled.
If a client has several registrations in a server then the server will make call attempts to all available registrations. statusCallbackEvent events sets will be invoked for all registrations. But if no client registration is available (a client is not registered) then no call attempts will be made and no statusCallbackEvent event will be invoked.
| Event | Description |
|---|---|
initiated |
The |
ringing |
The |
answered |
The |
completed |
The |
statusCallback
The statusCallback attribute allows you to specify a URL for Restcomm to send webhook requests to on each event specified in the statusCallbackEvent attribute.
statusCallbackMethod
The statusCallbackMethod attribute allows you to specify which HTTP method Restcomm should use when requesting the URL in the statusCallback attribute. The default is POST.
Status Callback HTTP Parameters
The parameters Restcomm passes to your application in its asynchronous request to the StatusCallback URL include all parameters passed in a synchronous request to retrieve RCML when Restcomm receives a call to one of your Restcomm numbers. The full list of parameters and descriptions of each are in the RCML Voice Request documentation Request Parameters.
When the call progress events are fired, the Status Callback request also passes these additional parameters:
| Parameter | Description |
|---|---|
CallDuration |
The duration in seconds of the just-completed call. Only present in the |
Timestamp |
The timestamp when the event was fired, given as UTC in RFC 2822 format. |
CallbackSource |
A string that describes the source of the webhook. This is provided to help disambiguate why the webhook was made. On Status Callbacks, this value is always |
SequenceNumber |
The order in which the events were fired, starting from |
ParentCallSid |
A unique identifier for the parent call. |
Examples
Example 1: Dialing to a client
In this example, we want to connect the current call to a client named jenny. To connect the call to jenny, use a <Dial> verb with a <Client> noun nested inside.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial>
<Client>Alice</Client>
</Dial>
</Response>
Example 2: Simultaneous Dialing
You can use up to ten total <Number> and <Client> nouns within a <Dial> verb to dial multiple phone numbers and clients at the same time. The first person to answer the call will be connected to the caller, while the rest of the call attempts are hung up.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial callerId="+19898XXXXXXX">
<Number>123-321-4321</Number>
<Client>jenny</Client>
<Client>tommy</Client>
</Dial>
</Response>
Example 3: Call Progress Events
In this case, we want to receive a webhook for each call progress event when dialing a Client using <Dial>.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Dial>
<Client
statusCallbackEvent='initiated,ringing,answered,completed'
statusCallback='https://myapp.com/calls/events'
statusCallbackMethod='POST'>
thomas
</Client>
</Dial>
</Response>