Skip to content

DeviceStateChange - [res_manager_devicestate]

Synopsis

Set a device state

Since

24.1.0, 23.7.0, 22.13.0, 20.23.0

Description

Sets a device state value.

This can be used to manually synchronize the device state of remote devices. It should NOT be used to set the device state of local devices.

Syntax

Action: DeviceStateChange
ActionID: <value>
Device: <value>
State: <value>
[Cachable: <value>]
EntityID: <value>
Arguments
  • ActionID - ActionID for this transaction. Will be returned.

  • Device - Device name. Does not need to be Custom; however, set device states for non-Custom devices with caution.

  • State - The new device state value.
    Should be one of the following:
    The possible values are:
    UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING | RINGINUSE | ONHOLD

  • Cachable - Whether or not this device state is cachable. Default is true, which is needed to persist the update.

  • EntityID - The Entity ID of the remote Asterisk system that originated this device state update.
    If the Entity ID provided matches the local Asterisk system's Entity ID, the update will be rejected.

See Also

Generated Version

This documentation was generated from Asterisk branch 22 using version GIT