Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Table of Contents
minLevel2

call_routing_groups.list

Description

Fetch a list of call routing groups.

Versioning Notes

Prior to version 1.1, the call_routing_group object structure was different. See below.

Arguments

None.

Example Requests & Responses

Example One

Request

Fetch a list of call routing groups.

Code Block
{
    'method' => 'call_routing_groups.list',
    'parameters' => { }
}

Response

Code Block
{
          'call_routing_groups' => [
/* Example PRI group */
                                     {
                                       'ports' => {
                                                    '4' => {
                                                             'all_channels' => '1',
                                                           },
                                                    '1' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '3' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '2' => {
                                                             'all_channels' => '0',
                                                           }
                                                  },
                                       'object_type' => 'call_routing_group',
                                       'group_type' => 'pri',
                                       'name' => 'pri group',
                                       'context' => 'prigroup',
                                       'object_name' => 'pri group',
                                       'object_id' => 252
                                     },
/* Example SIP group */
                                     {
                                       'sip_endpoints' => [
                                                            '77',
                                                            '79'
                                                          ],
                                       'ports' => {
                                                    '4' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '1' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '3' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '2' => {
                                                             'all_channels' => '0',
                                                           }
                                                  },
                                       'object_type' => 'call_routing_group',
                                       'group_type' => 'sip',
                                       'name' => 'sip endpoints group',
                                       'context' => 'sipendpointsgroup',
                                       'object_name' => 'sip endpoints group',
                                       'object_id' => 258
                                     },
/* Example non-PRI group */
                                     {
                                       'ports' => {
                                                    '4' => {
                                                             'all_channels' => '0',
                                                           },
                                                    '1' => {
                                                             'channel_list' => [
                                                                                 '1',
                                                                                 '2',
                                                                                 '3',
                                                                                 '4',
                                                                                 '5',
                                                                                 '6',
                                                                                 '7',
                                                                                 '8',
                                                                                 '9',
                                                                                 '10',
                                                                                 '11',
                                                                                 '12',
                                                                                 '13',
                                                                                 '14',
                                                                                 '15',
                                                                                 '16',
                                                                                 '17',
                                                                                 '18',
                                                                                 '19',
                                                                                 '20',
                                                                                 '21',
                                                                                 '22',
                                                                                 '23',
                                                                                 '24'
                                                                               ],
                                                             'all_channels' => '1',
                                                           },
                                                    '3' => {
                                                             'channel_list' => [
                                                                                 '1',
                                                                                 '2',
                                                                                 '3',
                                                                                 '4',
                                                                                 '5',
                                                                                 '6'
                                                                               ],
                                                             'all_channels' => '0',
                                                           },
                                                    '2' => {
                                                             'all_channels' => '0',
                                                           }
                                                  },
                                       'object_type' => 'call_routing_group',
                                       'group_type' => 'analog',
                                       'name' => 'E&M group',
                                       'context' => 'EMgroup',
                                       'object_name' => 'E&M group',
                                       'object_id' => 272
                                     },
}

Example Requests & Responses – Prior to v. 1.1

Example One

Request

Fetch a list of call routing groups.

Code Block
{
    'method' => 'call_routing_groups.list',
    'parameters' => { }
}

Response

Code Block
{
          'call_routing_groups' => [
                                     {
                                       'port-1' => '1',
                                       'group_name' => 'my pretty t1 group',
                                       'group_type' => 't1_e1',
                                       'port-2' => '1',
                                       'context' => 't1group',
                                     },
                                     {
                                       'sip_endpoints' => [
                                                            '200',
                                                            '211'
                                                          ],
                                       'port-1' => '0',
                                       'group_name' => 'Awesome sip group',
                                       'group_type' => 'sip',
                                       'port-2' => '0',
                                       'context' => 'sipgroup',
                                     }
                                   ],
}