Skip to main content

Update Availability

This event is used to update the agent availability setting.

{
  "type": "API.UPDATE_AVAILABILITY",
  "payload": {
    "status": "String!"
  }
}

Usage​

Agent availability is the only why to indicate to your teammate and to our system if you are able to take calls or not.

You can change your availability setting by using the API.UPDATE_AVAILABILITY event.

Available​

{
  "type": "API.UPDATE_AVAILABILITY",
  "payload": {
    "status": "always_opened"
  }
}

By sending this event, you will make yourself available to take calls.

note

If you are in-call or if you are in after_call_work mode, changing this setting will not make you available unless you are in a state where you can take calls.

Automatic Schedule​

{
  "type": "API.UPDATE_AVAILABILITY",
  "payload": {
    "status": "auto"
  }
}

By sending this event, you will make yourself available to take calls only during your working hours.

Unavailable​

{
  "type": "API.UPDATE_AVAILABILITY",
  "payload": {
    "status": "always_closed | other | doing_back_office | in_training | on_a_break | out_for_lunch"
  }
}

By sending this event, you will make yourself unavailable to receive calls.

note

By sending this event, you might receive a USER.AVAILABILITY_CHANGED indicating your new availability status.