End of Life Products and Features

1 Description
2 Versioning Notes
3 Arguments
4 Example Requests & Responses
- 4.1 Example One
  - 4.1.1 Request
  - 4.1.2 Response

Description

Save a new call routing group or changes to an existing call routing group.

Versioning Notes

In versions of the API prior to 1.1, "name" is not a valid attribute. Rather "group_name" is used in its place.

Arguments

name	Required	value type	default value

name	Required	value type	default value
name	yes	string	none
old_name	no	string	previous value of "name" when attempting to rename a group.
group_type	yes	'sip' or 'pri' or 'analog'	none
ports	object with members 'all_channels' and 'channel_list' which describe ports and channels in this group	object	no ports or channels selected
sip_endpoints	yes, if group_type=sip	array of the object_ids for all sip endpoints in this group	none

Example Requests & Responses

Example One

Request

Save a new call routing group or changes to an existing call routing group.

/* A SIP Group */
{
    'method' => 'call_routing_group.save',
    'parameters' => {
          'name' => 'sip group',
          'group_type' => 'sip',
          'sip_endpoints' => [
                               '200',
                               '211'
                             ],
        }

/* A T1/E1 PRI Group */
{
    'method' => 'call_routing_group.save',
    'parameters' => {
          'name' => 'pri group',
          'group_type' => 'pri',
          'ports' => {
                    '4' => {
                              'all_channels' => '1',
                           },
                    '3' => {
                              'all_channels' => '0',
                    },
        }

/* A T1/E1 Non-PRI Group */
{
    'method' => 'call_routing_group.save',
    'parameters' => {
          'name' => 'e&m group',
          'group_type' => 'analog',
          'ports' => {
                    '4' => {
                              'all_channels' => '1',
                           },
                    '3' => {
                              'all_channels' => '0',
                              'channel_list' => [
                                                   '1',
                                                   '2',
                                                   '3'
                                                ],
                           },
                    },
        }

Response

{
          'result' => 'success'
 }

Or

{
          'result' => 'error',
          'error' => 'An Error String',
          'error_key' => 'AN_ERROR_LANGUAGE_KEY',
 }

End of Life Products and Features - call_routing_group.save