Ring Group

Ring groups are similar to email group aliases. Multiple user addresses can be part of a group. A call to the group would ring the phone of each of the members in that group.

Group Address Add

Add a GroupAddress to an Organization.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “GroupAddressAdd”
SessionId Authenticated Session identifier.
OrganizationId A positive integer which references a unique organization.
Username The username portion of the address to add.
Domain The domain portion of the address to add.
Ordering ‘parallel’ | ‘sequential’
Timeout A positive integer indicating the max length of time in seconds a call attempt is made.
MemberAddresses An array of existing SIP UserAddresses of the form array(UserAddress => Priority) which make up the group. Priority is an integer specifying the relative priority of the address in the group. More explicitly, the URI will contain: MemberAddresses[user1@example.onsip.com]=1&MemberAddresses[user2@example.onsip.com]=2
Optional ParametersDefaultDescription
DefaultAddress If not set, no failover will be attempted. A failover SIP address to use in the event of a timeout or negative response.

Result Element Schema

GroupAddressAdd.rnc:

GroupAddressAdd.rng, GroupAddress.rng, Address.rng, DefaultAddress.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=GroupAddressAdd&SessionId=ogjovs6t6o8agfih9hf4sq3f90&OrganizationId=25018&Username=ring&Domain=example.onsip.com&Ordering=parallel&Timeout=10&MemberAddresses[james%example.onsip.com]=1' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var data = new FormData();
data.append('Action', 'GroupAddressAdd');
data.append('SessionId', 'ogjovs6t6o8agfih9hf4sq3f90');
data.append('OrganizationId', '25018');
data.append('Username', 'ring');
data.append('Domain', 'example.onsip.com');
data.append('Ordering', 'parallel');
data.append('Timeout', '10');
data.append('MemberAddresses[john@example.onsip.com]', '1');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-18T17:49:25+00:00</DateTime>
      <Duration>0</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>GroupAddressAdd</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>ogjovs6t6o8agfih9hf4sq3f90</Value>
        </Parameter>
        <Parameter>
          <Name>OrganizationId</Name>
          <Value>25018</Value>
        </Parameter>
        <Parameter>
          <Name>Username</Name>
          <Value>ring</Value>
        </Parameter>
        <Parameter>
          <Name>Domain</Name>
          <Value>example.onsip.com</Value>
        </Parameter>
        <Parameter>
          <Name>Ordering</Name>
          <Value>parallel</Value>
        </Parameter>
        <Parameter>
          <Name>Timeout</Name>
          <Value>10</Value>
        </Parameter>
        <Parameter>
          <Name>MemberAddresses</Name>
          <Array>
            <Elements>
              <Element>
                <Key>john%40example.onsip.com</Key>
                <Value>1</Value>
              </Element>
            </Elements>
          </Array>
        </Parameter>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>ogjovs6t6o8agfih9hf4sq3f90</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <GroupAddressAdd>
      <GroupAddress>
        <Ordering>parallel</Ordering>
        <Timeout>10</Timeout>
        <Address>
        <AddressId>674910</AddressId>
        <Username>ring</Username>
        <Domain>example.onsip.com</Domain>
        <Type>group</Type>
        <Name>ring</Name>
        <Modified>2014-04-18T19:29:16+00:00</Modified>
        <Created>2014-04-18T19:29:16+00:00</Created>
        <CplText>
          <cpl xmlns="urn:ietf:params:xml:ns:cpl"> <subaction id="default-action"> <reject status="reject"/> </subaction> <subaction id="do-proxy"> <proxy recurse="yes" timeout="10" ordering="parallel"> <busy><sub ref="default-action"/></busy> <noanswer><sub ref="default-action"/></noanswer> <redirection><sub ref="default-action"/></redirection> <failure><sub ref="default-action"/></failure> <default><sub ref="default-action"/></default> </proxy> </subaction> <subaction id="location0"> <lookup source="registration" aor="james@example.onsip.com" clear="no"> <success><sub ref="do-proxy"/></success> <notfound><sub ref="do-proxy"/></notfound> <failure><sub ref="do-proxy"/></failure> </lookup> </subaction> <incoming> <sub ref="location0"/> </incoming> </cpl>
          </CplText>
        </Address>
        <GroupMemberAddresses>
          <GroupMemberAddress>
            <Priority>1</Priority>
            <Address>
              <AddressId>485802</AddressId>
              <Username>john</Username>
              <Domain>example.onsip.com</Domain>
              <Type>user</Type>
              <Name>John Doe</Name>
              <Modified>2013-06-03T13:47:29+00:00</Modified>
              <Created>2013-06-03T13:47:29+00:00</Created>
              <CplText><cpl xmlns="urn:ietf:params:xml:ns:cpl"/></CplText>
            </Address>
          </GroupMemberAddress>
        </GroupMemberAddresses>
      </GroupAddress>
      <Organization>
        <OrganizationId>25018</OrganizationId>
        <AccountId>22543</AccountId>
        <Service>hosted</Service>
        <Domain>example.onsip.com</Domain>
        <CallerId/>
        <CallerIdName/>
        <CallerIdNumber/>
        <Status>enabled</Status>
        <ExtendedDialing>false</ExtendedDialing>
        <E911Provisioning>false</E911Provisioning>
        <BusyLampField>false</BusyLampField>
        <Authenticated>true</Authenticated>
        <RegistrationLimit>0</RegistrationLimit>
        <Modified>2013-06-03T13:47:29+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>John Doe</Name>
          <Organization>example</Organization>
          <Address>555 example street</Address>
          <City>Brooklyn</City>
          <State>NY</State>
          <Zipcode>11201</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.com</Email>
          <Modified>2013-06-03T13:47:29+00:00</Modified>
        </Contact>
      </Organization>
    </GroupAddressAdd>
  </Result>
</Response>

Group Address Read

Returns information about a GroupAddress.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “GroupAddressRead”
SessionId Authenticated Session identifier.
Address A SIP “group” address of the form username@domain (ie sales@example.onsip.com).

Result Element Schema

GroupAddressRead.rnc:

GroupAddressRead.rng, GroupAddress.rng, Address.rng, DefaultAddress.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=GroupAddressRead&SessionId=ogjovs6t6o8agfih9hf4sq3f90&Address=ring@example.onsip.com' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
var data = new FormData();
data.append('Action', 'GroupAddressRead');
data.append('SessionId', 'ogjovs6t6o8agfih9hf4sq3f90');
data.append('Address', 'ring@example.onsip.com');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-18T17:49:25+00:00</DateTime>
      <Duration>0</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>GroupAddressRead</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>ogjovs6t6o8agfih9hf4sq3f90</Value>
        </Parameter>
        <Parameter>
          <Name>Address</Name>
          <Value>ring@example.onsip.com</Value>
        </Parameter>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>ogjovs6t6o8agfih9hf4sq3f90</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <GroupAddressRead>
    <GroupAddress>
        <Ordering>parallel</Ordering>
        <Timeout>10</Timeout>
        <Address>
        <AddressId>674910</AddressId>
        <Username>ring</Username>
        <Domain>example.onsip.com</Domain>
        <Type>group</Type>
        <Name>ring</Name>
        <Modified>2014-04-18T19:29:16+00:00</Modified>
        <Created>2014-04-18T19:29:16+00:00</Created>
        <CplText>
          <cpl xmlns="urn:ietf:params:xml:ns:cpl"> <subaction id="default-action"> <reject status="reject"/> </subaction> <subaction id="do-proxy"> <proxy recurse="yes" timeout="10" ordering="parallel"> <busy><sub ref="default-action"/></busy> <noanswer><sub ref="default-action"/></noanswer> <redirection><sub ref="default-action"/></redirection> <failure><sub ref="default-action"/></failure> <default><sub ref="default-action"/></default> </proxy> </subaction> <subaction id="location0"> <lookup source="registration" aor="james@example.onsip.com" clear="no"> <success><sub ref="do-proxy"/></success> <notfound><sub ref="do-proxy"/></notfound> <failure><sub ref="do-proxy"/></failure> </lookup> </subaction> <incoming> <sub ref="location0"/> </incoming> </cpl>
          </CplText>
        </Address>
        <GroupMemberAddresses>
          <GroupMemberAddress>
            <Priority>1</Priority>
            <Address>
              <AddressId>485802</AddressId>
              <Username>john</Username>
              <Domain>example.onsip.com</Domain>
              <Type>user</Type>
              <Name>John Doe</Name>
              <Modified>2013-06-03T13:47:29+00:00</Modified>
              <Created>2013-06-03T13:47:29+00:00</Created>
              <CplText><cpl xmlns="urn:ietf:params:xml:ns:cpl"/></CplText>
            </Address>
          </GroupMemberAddress>
        </GroupMemberAddresses>
      </GroupAddress>
      <Organization>
        <OrganizationId>25018</OrganizationId>
        <AccountId>22543</AccountId>
        <Service>hosted</Service>
        <Domain>example.onsip.com</Domain>
        <CallerId/>
        <CallerIdName/>
        <CallerIdNumber/>
        <Status>enabled</Status>
        <ExtendedDialing>false</ExtendedDialing>
        <E911Provisioning>false</E911Provisioning>
        <BusyLampField>false</BusyLampField>
        <Authenticated>true</Authenticated>
        <RegistrationLimit>0</RegistrationLimit>
        <Modified>2013-06-03T13:47:29+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>John Doe</Name>
          <Organization>example</Organization>
          <Address>555 example street</Address>
          <City>Brooklyn</City>
          <State>NY</State>
          <Zipcode>11201</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.com</Email>
          <Modified>2013-06-03T13:47:29+00:00</Modified>
        </Contact>
      </Organization>
    </GroupAddressRead>
  </Result>
</Response>

Group Address Browse

Returns information about a group of GroupAddresses.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “GroupAddressBrowse”
SessionId Authenticated Session identifier.
One and Only One of the Following Parameters Description
AccountId A positive integer which references a unique Account.
OrganizationId A positive integer which references a unique Organization.
Optional ParametersDefaultDescription
OrderBy   Username | Domain | GroupAddressId
Limit 20 The maximum number of records to return.
Offset 0 The offset of the first record to return. The offset of the initial record is 0 (not 1).
CalcFound true Calculate how many records there would be in the result set, disregarding any Limit parameter.

Result Element Schema

GroupAddressBrowse.rnc:

GroupAddressBrowse.rng, GroupAddress.rng, Address.rng, DefaultAddress.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=GroupAddressBrowse&SessionId=ogjovs6t6o8agfih9hf4sq3f90&OrganizationId=25018&AccountId=22543' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
var data = new FormData();
data.append('Action', 'GroupAddressBrowse');
data.append('SessionId', 'ogjovs6t6o8agfih9hf4sq3f90');
data.append('OrganizationId', '25018');
data.append('AccountId', '22543');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-18T17:49:25+00:00</DateTime>
      <Duration>0</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>GroupAddressBrowse</Value>
          <Name>SessionId</Name>
          <Value>ogjovs6t6o8agfih9hf4sq3f90</Value>
          <Name>OrganizationId</Name>
          <Value>25018</Value>
          <Name>AccountId</Name>
          <Value>22543</Value>
        </Parameter>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>ogjovs6t6o8agfih9hf4sq3f90</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <GroupAddressBrowse>
      <GroupAddresses Limit="20" Offset="0" Found="1">
        <GroupAddress>
          <Ordering>parallel</Ordering>
          <Timeout>10</Timeout>
          <Address>
          <AddressId>674910</AddressId>
          <Username>ring</Username>
          <Domain>example.onsip.com</Domain>
          <Type>group</Type>
          <Name>ring</Name>
          <Modified>2014-04-18T19:29:16+00:00</Modified>
          <Created>2014-04-18T19:29:16+00:00</Created>
          <CplText>
            <cpl xmlns="urn:ietf:params:xml:ns:cpl"> <subaction id="default-action"> <reject status="reject"/> </subaction> <subaction id="do-proxy"> <proxy recurse="yes" timeout="10" ordering="parallel"> <busy><sub ref="default-action"/></busy> <noanswer><sub ref="default-action"/></noanswer> <redirection><sub ref="default-action"/></redirection> <failure><sub ref="default-action"/></failure> <default><sub ref="default-action"/></default> </proxy> </subaction> <subaction id="location0"> <lookup source="registration" aor="james@example.onsip.com" clear="no"> <success><sub ref="do-proxy"/></success> <notfound><sub ref="do-proxy"/></notfound> <failure><sub ref="do-proxy"/></failure> </lookup> </subaction> <incoming> <sub ref="location0"/> </incoming> </cpl>
            </CplText>
          </Address>
          <GroupMemberAddresses>
            <GroupMemberAddress>
              <Priority>1</Priority>
              <Address>
                <AddressId>485802</AddressId>
                <Username>john</Username>
                <Domain>example.onsip.com</Domain>
                <Type>user</Type>
                <Name>John Doe</Name>
                <Modified>2013-06-03T13:47:29+00:00</Modified>
                <Created>2013-06-03T13:47:29+00:00</Created>
                <CplText><cpl xmlns="urn:ietf:params:xml:ns:cpl"/></CplText>
              </Address>
            </GroupMemberAddress>
          </GroupMemberAddresses>
        </GroupAddress>
      </GroupAddresses>
    </GroupAddressBrowse>
  </Result>
</Response>

Group Address Delete

Delete a GroupAddress.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “GroupAddressDelete”
SessionId Authenticated Session identifier.
Address A SIP “group” address of the form username@domain (ie sales@example.onsip.com).

Result Element Schema

GroupAddressDelete.rnc:

GroupAddressDelete.rng, GroupAddress.rng, Address.rng, DefaultAddress.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=GroupAddressDelete&SessionId=ogjovs6t6o8agfih9hf4sq3f90&Address=ring@example.onsip.com' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
var data = new FormData();
data.append('Action', 'GroupAddressDelete');
data.append('SessionId', 'ogjovs6t6o8agfih9hf4sq3f90');
data.append('Address', 'ring@example.onsip.com');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-18T17:49:25+00:00</DateTime>
      <Duration>0</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>GroupAddressDelete</Value>
        </Parameter>
        <Parameter>
          <Name>GroupAddressDelete</Name>
          <Value>ogjovs6t6o8agfih9hf4sq3f90</Value>
        </Parameter>
        <Parameter>
          <Name>Address</Name>
          <Value>ring@example.onsip.com</Value>
        </Parameter>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>ogjovs6t6o8agfih9hf4sq3f90</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <GroupAddressDelete>
      <Organization>
        <OrganizationId>25018</OrganizationId>
        <AccountId>22543</AccountId>
        <Service>hosted</Service>
        <Domain>example.onsip.com</Domain>
        <CallerId/>
        <CallerIdName/>
        <CallerIdNumber/>
        <Status>enabled</Status>
        <ExtendedDialing>false</ExtendedDialing>
        <E911Provisioning>false</E911Provisioning>
        <BusyLampField>false</BusyLampField>
        <Authenticated>true</Authenticated>
        <RegistrationLimit>0</RegistrationLimit>
        <Modified>2013-06-03T13:47:29+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>John Doe</Name>
          <Organization>example</Organization>
          <Address>555 example street</Address>
          <City>Brooklyn</City>
          <State>NY</State>
          <Zipcode>11201</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.com</Email>
          <Modified>2013-06-03T13:47:29+00:00</Modified>
        </Contact>
      </Organization>
    </GroupAddressDelete>
  </Result>
</Response>

Group Address Edit

Update a GroupAddress.

Authentication & Authorization

AuthenticationAuthorization
Authenticated Session Account Admin

Request Parameters

Required ParametersDescription
Action “GroupAddressEdit”
SessionId Authenticated Session identifier.
Address A SIP “group” address of the form username@domain (ie sales@example.onsip.com).
Ordering ‘parallel’ | ‘sequential’
Timeout A positive integer indicating the max length of time in seconds a call attempt is made.
MemberAddresses An array of existing SIP UserAddresses of the form array(UserAddress => Priority) which make up the group. Priority is an integer specifying the relative priority of the address in the group. More explicitly, the URI will contain: MemberAddresses[user1@example.onsip.com]=1&MemberAddresses[user2@example.onsip.com]=2
Optional ParametersDefaultDescription
DefaultAddress If not set, no failover will be attempted. A failover SIP address to use in the event of a timeout or negative response.

Result Element Schema

GroupAddressEdit.rnc:

GroupAddressEdit.rng, GroupAddress.rng, Address.rng, DefaultAddress.rng

Sample Request

cURL
1
2
3
4
curl -X POST \
--data \
'Action=GroupAddressEdit&SessionId=ogjovs6t6o8agfih9hf4sq3f90&Address=ring@example.onsip.com&Ordering=parallel&Timeout=100&MemberAddresses[test1@example.onsip.com]=1' \
https://api.onsip.com/api
JavaScript
1
2
3
4
5
6
7
8
9
10
11
12
13
14
var data = new FormData();
data.append('Action', 'GroupAddressEdit');
data.append('SessionId', 'ogjovs6t6o8agfih9hf4sq3f90');
data.append('Address', 'ring@example.onsip.com');
data.append('Ordering', 'parallel');
data.append('Timeout', '100');
data.append('MemberAddresses[test1@example.onsip.com]', '1');

var xhr = new XMLHttpRequest();
xhr.open('POST', 'https://api.onsip.com/api', true);
xhr.onload = function () {
  console.log(this.responseText);
}
xhr.send(data);

Sample Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<Response xmlns="http://www.jnctn.net/ns/rest/2006-01">
  <Context>
    <Action>
      <IsCompleted>true</IsCompleted>
    </Action>
    <Request>
      <IsValid>true</IsValid>
      <DateTime>2014-04-18T17:49:25+00:00</DateTime>
      <Duration>0</Duration>
      <Parameters>
        <Parameter>
          <Name>Action</Name>
          <Value>GroupAddressEdit</Value>
        </Parameter>
        <Parameter>
          <Name>SessionId</Name>
          <Value>ogjovs6t6o8agfih9hf4sq3f90</Value>
        </Parameter>
        <Parameter>
          <Name>Address</Name>
          <Value>ring@example.onsip.co</Value>
        </Parameter>
        <Parameter>
          <Name>Ordering</Name>
          <Value>parallel</Value>
        </Parameter>
        <Parameter>
          <Name>Timeout</Name>
          <Value>100</Value>
        </Parameter>
        <Parameter>
          <Name>MemberAddresses</Name>
          <Array>
            <Elements>
              <Element>
                <Key>test%40example.onsip.com</Key>
                <Value>1</Value>
              </Element>
            </Elements>
          </Array>
        </Parameter>
    </Request>
    <Session>
      <IsEstablished>true</IsEstablished>
      <SessionId>ogjovs6t6o8agfih9hf4sq3f90</SessionId>
      <UserId>152255</UserId>
      <Roles>
        <Role>
          <Name>Account Admin</Name>
        </Role>
      </Roles>
    </Session>
  </Context>
  <Result>
    <GroupAddressEdit>
    <GroupAddress>
        <Ordering>parallel</Ordering>
        <Timeout>10</Timeout>
        <Address>
        <AddressId>674910</AddressId>
        <Username>ring</Username>
        <Domain>example.onsip.com</Domain>
        <Type>group</Type>
        <Name>ring</Name>
        <Modified>2014-04-18T19:29:16+00:00</Modified>
        <Created>2014-04-18T19:29:16+00:00</Created>
        <CplText>
          <cpl xmlns="urn:ietf:params:xml:ns:cpl"> <subaction id="default-action"> <reject status="reject"/> </subaction> <subaction id="do-proxy"> <proxy recurse="yes" timeout="10" ordering="parallel"> <busy><sub ref="default-action"/></busy> <noanswer><sub ref="default-action"/></noanswer> <redirection><sub ref="default-action"/></redirection> <failure><sub ref="default-action"/></failure> <default><sub ref="default-action"/></default> </proxy> </subaction> <subaction id="location0"> <lookup source="registration" aor="james@example.onsip.com" clear="no"> <success><sub ref="do-proxy"/></success> <notfound><sub ref="do-proxy"/></notfound> <failure><sub ref="do-proxy"/></failure> </lookup> </subaction> <incoming> <sub ref="location0"/> </incoming> </cpl>
          </CplText>
        </Address>
        <GroupMemberAddresses>
          <GroupMemberAddress>
            <Priority>1</Priority>
            <Address>
              <AddressId>485802</AddressId>
              <Username>test</Username>
              <Domain>example.onsip.com</Domain>
              <Type>user</Type>
              <Name>John Doe</Name>
              <Modified>2013-06-03T13:47:29+00:00</Modified>
              <Created>2013-06-03T13:47:29+00:00</Created>
              <CplText><cpl xmlns="urn:ietf:params:xml:ns:cpl"/></CplText>
            </Address>
          </GroupMemberAddress>
        </GroupMemberAddresses>
      </GroupAddress>
      <Organization>
        <OrganizationId>25018</OrganizationId>
        <AccountId>22543</AccountId>
        <Service>hosted</Service>
        <Domain>example.onsip.com</Domain>
        <CallerId/>
        <CallerIdName/>
        <CallerIdNumber/>
        <Status>enabled</Status>
        <ExtendedDialing>false</ExtendedDialing>
        <E911Provisioning>false</E911Provisioning>
        <BusyLampField>false</BusyLampField>
        <Authenticated>true</Authenticated>
        <RegistrationLimit>0</RegistrationLimit>
        <Modified>2013-06-03T13:47:29+00:00</Modified>
        <Created>2013-06-03T13:47:29+00:00</Created>
        <Contact>
          <Name>John Doe</Name>
          <Organization>example</Organization>
          <Address>555 example street</Address>
          <City>Brooklyn</City>
          <State>NY</State>
          <Zipcode>11201</Zipcode>
          <Country>United States of America</Country>
          <CountryId>207</CountryId>
          <Phone>1-555-555-5555</Phone>
          <Email>john@example.com</Email>
          <Modified>2013-06-03T13:47:29+00:00</Modified>
        </Contact>
      </Organization>
    </GroupAddressEdit>
  </Result>
</Response>

Topics: Developer Docs