Calling

View as Markdown

Relay.Calling

This represents the API interface for the Calling Relay Service. This object is used to make requests related to managing end to end calls.

Methods

dial

Make an outbound Call and waits until it has been answered or hung up.

Parameters

ParameterTypeDefaultDescription
typestringrequiredThe type of call. Only phone and sip are currently supported
fromstringrequiredThe party the call is coming from. Must be a SignalWire number or SIP endpoint that you own
tostringrequiredThe party you are attempting to call
timeoutnumberoptionalThe time, in seconds, the call will ring before going to voicemail
from_namestringoptionalSIP only. The caller ID name to display
headersHeader[]optionalSIP only. Array of Header objects like: { name: string, value: string }. Must be X- headers only, see example below
codecsstringoptionalSIP only. Optional array of desired codecs in order of preference. Supported values are PCMU, PCMA, OPUS, G729, G722, VP8, H264. Default is parent leg codec(s)
webrtc_mediabooleanoptionalSIP only. If true, WebRTC media is negotiated. Default is parent leg setting

Returns

Promise<Relay.Calling.DialResult> - Promise that will be fulfilled with a Relay.Calling.DialResult object.

Examples

Make an outbound Call and grab the call object if it was answered.

1async function main() {
2  const dialResult = await client.calling.dial({
3    type: 'phone',
4    from: '+1XXXXXXXXXX',
5    to: '+1YYYYYYYYYY',
6    timeout: 30
7  })
8
9  if (dialResult.successful) {
10    const { call } = dialResult
11  }
12}
13
14main().catch(console.error)

Make an outbound Call to a SIP endpoint.

1async function main() {
2  const dialResult = await client.calling.dial({
3    type: 'sip',
4    from: 'sip:XXXX@XXXXX.XXX',
5    to: 'sip:YYYY@YYYYY.YYY',
6    timeout: 30
7  })
8
9  if (dialResult.successful) {
10    const { call } = dialResult
11  }
12}
13
14main().catch(console.error)

Dial a SIP endpoint with custom headers.

1client.calling.dial({
2  type: 'sip',
3  from: 'sip:XXXX@XXXXX.XXX',
4  to: 'sip:YYYY@YYYYY.YYY',
5  timeout: 30,
6  headers: [{
7    "name": "X-Relay-Call-ID",
8    "value": "697a4e98-f452-416f-b11e-63c19112f542"
9  }, {
10    "name": "X-CID",
11    "value": "124077399_129412436@206.117.11.72"
12  }, {
13    "name": "X-Target-Type",
14    "value": "classic"
15  }]
16})

newCall

Create a new Call object. The call has not started yet allowing you to attach event listeners on it.

Parameters

See dial for the parameter list.

Returns

Call - A new Relay.Calling.Call object.

Example

1const call = client.calling.newCall({
2  type: 'phone',
3  from: '+1XXXXXXXXXX',
4  to: '+1YYYYYYYYYY',
5  timeout: 30
6})
7
8// Use the call object...