cxengage-javascript-sdk.modules.voice

cancel-dial

(cancel-dial & args__9078__auto__)

Cancel an outbound dial (before the interaction has been received).

CxEngage.interactions.voice.cancelDial({
  interactionId: '{{uuid}}'
});

customer-hold

(customer-hold & args__9078__auto__)

Place the customer on hold.

CxEngage.interactions.voice.customerHold({
  interactionId: '{{uuid}}'
});

customer-resume

(customer-resume & args__9078__auto__)

Take the customer off of hold.

CxEngage.interactions.voice.customerResume({
  interactionId: '{{uuid}}'
});

dial

(dial & args__9078__auto__)

Perform an outbound dial.

CxEngage.interactions.voice.dial({
  phoneNumber: '{{number}}',
  outboundAni: '{{string}}' (Optional, used for outbound identifier),
  outboundIdentifierId: '{{uuid}}' (Optional, used for outbound identifier),
  outboundIdentifierListId: '{{uuid}}' (Optional, used for outbound identifier),
  flow-id: '{{uuid}}' (Optional, used to specify flow),
  popUri: '{{string}}' (Optional, used for salesforce screen pop),
  direction: '{{'inbound' / 'outbound' / 'agent-initiated'}} (Optional, defaults to agent-initiated),
  interactionMetadata: '{{map}}' (Optional, map to be included in interaction body)
});

mute

(mute & args__9078__auto__)

Mute a resource on the call.

CxEngage.interactions.voice.mute({
  interactionId: '{{uuid}}',
  targetResourceId: '{{uuid}}' (Optional, defaults to current user id)
});

remove-resource

(remove-resource & args__9078__auto__)

Remove a resource from the call (hang up the resource).

CxEngage.interactions.voice.resourceRemove({
  interactionId: '{{uuid}}',
  targetResourceId: '{{uuid}}' (Optional, defaults to current user id)
});

resource-hold

(resource-hold & args__9078__auto__)

Place a resource on the call on hold.

CxEngage.interactions.voice.resourceHold({
  interactionId: '{{uuid}}',
  targetResourceId: '{{uuid}}' (Optional, defaults to current user id)
});

resource-resume

(resource-resume & args__9078__auto__)

Take a resource on the call off of hold.

CxEngage.interactions.voice.resourceResume({
  interactionId: '{{uuid}}',
  targetResourceId: '{{uuid}}' (Optional, defaults to current user id)
});

resume-all

(resume-all & args__9078__auto__)

Take all resources on the call off of hold.

CxEngage.interactions.voice.resumeAll({
  interactionId: '{{uuid}}'
});

send-digits

(send-digits & args__9078__auto__)

Send a DTMF signal to the call (Twilio only).

CxEngage.interactions.voice.sendDigits({
  interactionId: '{{uuid}}',
  digit: '{{DTMF digit}}' (1-9, *, or #)
});

silent-monitor

(silent-monitor & args__9078__auto__)

start-recording

(start-recording & args__9078__auto__)

Start recording.

CxEngage.interactions.voice.startRecording({
  interactionId: '{{uuid}}'
});

stop-recording

(stop-recording & args__9078__auto__)

Stop recording.

CxEngage.interactions.voice.stopRecording({
  interactionId: '{{uuid}}'
});

unmute

(unmute & args__9078__auto__)

Unumute a resource on the call.

CxEngage.interactions.voice.unmute({
  interactionId: '{{uuid}}',
  targetResourceId: '{{uuid}}' (Optional, defaults to current user id)
});