End of Life Products and Features

1 Description
2 Arguments
3 Example Requests & Responses
- 3.1 Example One
  - 3.1.1 Request
  - 3.1.2 Or
  - 3.1.3 Response

Description

Delete one sip endpoint.

Arguments

name	required	value type

name	required	value type
object_name	yes, if no object_id specified	the 'name' parameter of a sip endpoint object
object_type	no	sip_endpoint
object_id	yes, if no object_name specified	integer representing the auto-increment field from the database

Example Requests & Responses

Example One

Request

Request deletion of one sip endpoint object by the gateway's database object_id or object_name. If the deletion was successful, the gateway will also return a list of call routing groups and call routing rules which have been invalidated by the deletion of this endpoint.

{
    'method' => 'sip_endpoint.delete',
    'parameters' => {
        'object_id' => '23'
    }
}

Or

{
    'method' => 'sip_endpoint.delete',
    'parameters' => {
        'object_name' => 'testunit'
    }
}

Response

{
          'result' => 'success'
          'invalid_rules' => [],
          'invalid_groups' => [],
 }

Or

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

End of Life Products and Features - sip_endpoint.delete