Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script

...

The presence information for an Extension extension is represented by the UnifiedAPI as a Presence resource. It contains the agent where the Extension extension is registered and the expiration date of the registration.

JSON representation

The following example below contains the Presence in JSON representation. All fields are fictitious.

Code Block
{
   "agentstatus": "0",
  "registrationextension": "-10003*001",
  "registration": "status[
	{ 
		"agent": "3CXPhone 5.0.14439.0",
  		"extensionregistration": "0003*001-1",
  		"expire": "0112011-02-10T15:10:55Z",
	}
  ]
}

Presence event fields

Name

Type

Description

agentStringThe agent that uses the extension.

registrationPhoneRegistrationSee PhoneRegistration
statusNumberDefines presence status. Possible values:
1 - online
2 - ringing
3 - busy
0 - unknown
extension

UAPI-Extension-Number

The phone number of the extension.

PhoneRegistration fields

Anchor
reg
reg

Name

Type

Description

registrationNumberDefines registration status.

Possible values:
1 -
Registered
registered
2 -
No
no registration necessary
-1 -
Not
not registered
-2 -
Registration
registration expired
0 -
Unknown
unknown
statusNumberDefines presence status.

Possible values:
1 -
Online
online
2 -
Ringing
ringing
3 -
Busy
busy
0 -
Unknownextension

UAPI-Extension-Number

The phone number of the Extension.
unknown
expireDateSpecifies registration expiration date.
Missing when
the
registration
is
has expired.

4psarelated
NameRelated Topics

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.