Number

The <Number> noun specifies a phone number to dial. You can use multiple <Number> nouns within a <Dial> verb to simultaneously call all of them at once. The first call to pick up is connected to the current call and the rest are hung up.

Number Attributes

Name Allowed Values Default Value

Name	Allowed Values	Default Value
Description	url	any url
none	call screening url	method
`GET`, `POST`	`POST`	method for call screening url
statusCallbackEvent	`initiated`, `ringing`, `answered`, `completed`	initiated,ringing,answered,completed
Event triggers for status callback	statusCallback	any url
none	statusCallback url	statusCallbackMethod
`GET`, `POST`	`POST`	method for statusCallback url

Description

url

any url

none

call screening url

method

GET, POST

POST

method for call screening url

statusCallbackEvent

initiated, ringing, answered, completed

initiated,ringing,answered,completed

Event triggers for status callback

statusCallback

any url

none

statusCallback url

statusCallbackMethod

GET, POST

POST

method for statusCallback url

url. The 'url' attribute allows you to specify a url for a RCML document that will run on the called party’s end, after he/she answers, but before the 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 current 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.

method

The 'method' attribute allows you to specify which HTTP method CPaaS should use when requesting the URL in the 'url' attribute. The default is POST.

statusCallbackEvent

When dialing out to a PSTN Number 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. To specify multiple events separate them with a comma: initiated,ringing,answered,completed. If a statusCallback is provided and no status callback events are specified the completed event will be sent 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 <Number> noun specifies a PSTN Number to dial. You can use multiple <Number> nouns within a <Dial> verb to simultaneously attempt a connection with many numbers at once. The first number to accept the incoming connection is connected to the call and the other connection attempts are canceled.

Event Description

Event	Description
initiated	The `initiated` event is fired when Restcomm starts dialing the call with CallStatus `initiated`
ringing	The `ringing` event is fired when the call starts ringing with CallStatus `ringing`
answered	The `answered` event is fired when the call is answered with CallStatus `in-progress`
completed	The `completed` event is fired when the call is completed regardless of the termination status with CallStatus `busy`, `completed`, `failed`, or `no-answer`

initiated

The initiated event is fired when Restcomm starts dialing the call with CallStatus initiated

ringing

The ringing event is fired when the call starts ringing with CallStatus ringing

answered

The answered event is fired when the call is answered with CallStatus in-progress

completed

The completed event is fired when the call is completed regardless of the termination status with CallStatus busy, completed, failed, or no-answer

statusCallback

The statusCallback attribute allows you to specify a URL for CPaaS to send webhook requests to on each event specified in the statusCallbackEvent attribute.

statusCallbackMethod

The statusCallbackMethod attribute allows you to specify which HTTP method CPaaS should use when requesting the URL in the statusCallback attribute. The default is POST.

Status Callback HTTP Parameters

The CPaaS parameters passed to your application in its asynchronous request to the StatusCallback URL include all parameters passed in a synchronous request to retrieve RCML when CPaaS receives a call to one of your numbers. The full list of Request Parameters can be found in the RCML Voice Request documentation.

When the call progress events are fired, the Status Callback request also passes these additional parameters:

Parameter Description

Parameter	Description
CallDuration	The duration in seconds of the just-completed call. Only present in the `completed` event.
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 `call-progress-events`.
SequenceNumber	The order in which the events were fired, starting from `0`. Although events are fired in order, they are made as separate HTTP requests and there is no guarantee they will arrive in the same order.
ParentCallSid	A unique identifier for the parent call.

CallDuration

The duration in seconds of the just-completed call. Only present in the completed event.

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 call-progress-events.

SequenceNumber

The order in which the events were fired, starting from 0. Although events are fired in order, they are made as separate HTTP requests and there is no guarantee they will arrive in the same order.

ParentCallSid

A unique identifier for the parent call.

Including proprietary SIP headers

This noun lets you customize proprietary SIP headers to be included in the outgoing SIP message. Those include the following SIP URI params syntax.

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Number>+131313?X-Custom-Header1=1234&X-Custom-Header2=4321</Number>
</Response>