Dial

This event is used when user tries to call either an external number or a teammate.

{
  "type": "DIALER.DIAL",
  "payload": {
    "from": "String!",
    "to": "String!"
  },
  "meta": {
    "tracking": {
      "dialing_mode": "String!"
    }
  }
}

Usage

When user tries to start an outgoing call, you should send the DIALER.DIAL event.

This event can be used to either call an external number or a teammate.

dial-external-number.js

{
  "type": "DIALER.DIAL",
  "payload": {
    "from": "+123456789",
    "to": "+123456789"
  },
  "meta": {
    "tracking": {
      "dialing_mode": "manual"
    }
  }
}

dial-teammate.js

{
  "type": "DIALER.DIAL",
  "payload": {
    "from": "+123456789",
    "to": "client:123"
  },
  "meta": {
    "tracking": {
      "dialing_mode": "teammate"
    }
  }
}

tip

When calling a teammate, you should use the client: prefix followed by the teammate's ID.

note

Calling a teammate is considered as an internal call and you won't be able to record it OR transfer it to another teammate.

This event is fire-and-forgot, you won't receive any acknowledgement. That being said, to know if the call has been successfully initiated, you will receive a DIALER.CALL_STATUS event which indicate the status of the ongoing call.

Reference

• from: The number that will be used to make the call. This number should be one of the user's phone numbers.
• to: The number that will be called. This can be either a phone number or a teammate's id.