Subscriber Object

This section outlines the Subscriber object.

Subscriber Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
authenticationToken read only	string	An encrypted analogue of the password filed, generated automatically.
callback createupdate	object	The callback object. Refer to the table below for more information.
created read only	string	The UNIX time stamp of the subscriber creation time.
details createupdate	string	The subscriber additional information.
didGroupReferences createupdate	array of objects	Data about the DID Group associated with the subscriber. Refer to the table below for more information.
email createupdate	string	The subscriber email address.
eventCallbackUrl createupdate	string	An external URL to be called when an event associated to this subscription is fired. This is a hidden field, it can be used to set or change the url attribute of the Callback object.
ext createupdate	string	The subscriber extension.
externalId read only	integer	The subscriber object ID in an external system.
firstName createupdate	string	The subscriber first name.
lastName createupdate	string	The subscriber last name.
login createupdate	string	The subscriber login to the API.
meetingRooms createupdate	array of objects	The meeting rooms, which this subscriber can possibly attend.
parentSid read only	string	The parent subscriber object identifier.
password createupdate	string	The subscriber password. This field is hidden from the response and never returned as a plain text.
phoneNumber createupdate	string	The subscriber phone number.
role createupdate	integer	The subscriber role. Values accepted in this field are: 1 for administrator. 2 for operator. 3 for regular user. The default value is 3.
sid read only	string	The subscriber identifier.

Callback Object

Attribute	Data Type	Description
id read only	integer	The callback identifier.
url createupdate	string	An external URL to which a POST request is sent when an event associated to this subscription is fired. This URL can be set or updated either directly or using the eventCallbackUrl of the Subscriber object.

DID Group Reference Object

The didGroupReferences array contains the didGroupId and state. The didGroupId references the DID group containing the phone numbers that can be dialed to access a Meeting Room.

Attribute	Data Type	Description
didGroupId createupdate	integer	The DID group identifier.
state createupdate	string	The state of the DID group. Values accepted in this field are: 0 for active (default) 1 for invalidated 2 for disabled

Sample Subscriber Object

{
    "authenticationToken": "MWMx0BU1YZE0MV==",
    "callback": {
        "id": 233944,
        "url": "http://mywebsite.com/conference/callback"
    },
    "created": 1586872518000,
    "details": "Some details about subscriber",
    "didGroupReferences": [
        {
            "didGroupId": 731,
            "state": 0
        }
    ],
    "email": "mail@carrierx.com",
    "externalId": -1,
    "firstName": "CarrierX",
    "lastName": "",
    "login": "test_carrierx_conference_135",
    "meetingRooms": [],
    "parentSid": "zzpF93QCVvfYYJb2KdPSzGW6lqGLB3qm",
    "phoneNumber": "9197473626",
    "role": 3,
    "sid": "rB0M9.EzXfaO4keb-opANwfb7CHx1Ph1"
}