Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script
Excerpt
This page describes the representation of the resources used by the Extension Presence Service.

Presence resource

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

JSON representation

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

Code Block
{
  "status": "0",
  "extension": "0003*001",
  "registration": [
	{ 
		"agent": "3CXPhone 5.0.14439.0",
		"registration": "-1",
		"expire": "2011-02-10T15:10:55Z"
	}
  ]
}

Presence event fields

Name

Type

Description

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
2 - no registration necessary
-1 - not registered
-2 - registration expired
0 - unknown
statusNumberDefines presence status. Possible values:
1 - online
2 - ringing
3 - busy
0 - unknown
expireDateSpecifies registration expiration date.
Missing when registration has expired.

4psarelated
NameRelated Topics

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