sip_endpoint.list
- Nathaniel Halbrooks
- Kelli Higdon
Owned by Nathaniel Halbrooks
Description
Fetch information about one sip endpoint.
Arguments
name | value type | required |
|---|---|---|
object_name | the 'name' parameter of a sip endpoint object | yes, if no object_id specified |
object_id | integer representing the auto-increment field from the database | yes, if no object_name specified |
Example Requests & Responses
Example One
Request
Requests information about one sip endpoint on this gateway by specifying the object_id from the gateway's configuration database.
{
    'method' => 'sip_endpoint.list',
    'parameters' => {
        'object_id' => '23'
    }
} |
Or:
{
    'method' => 'sip_endpoint.list',
    'parameters' => {
        'object_name' => 'phone'
    }
} |
Response
{
          'sip_endpoint' => {
                               {
                                 'remotesecret' => 'myremotesecret',
                                 'outboundproxy' => 'myproxy.example.tld',
                                 'nat' => 'yes',
                                 'audio_codecs' => [
                                                     {
                                                       'value' => '1',
                                                       'id' => 'ulaw'
                                                     },
                                                     {
                                                       'value' => '1',
                                                       'id' => 'alaw'
                                                     },
                                                     {
                                                       'value' => '1',
                                                       'id' => 'g722'
                                                     },
                                                     {
                                                       'value' => '1',
                                                       'id' => 'g726'
                                                     },
                                                     {
                                                       'value' => '1',
                                                       'id' => 'g729'
                                                     },
                                                     {
                                                       'value' => '1',
                                                       'id' => 'gsm'
                                                     }
                                                   ],
                                 'g726_pr' => '20',
                                 'sendrpid' => 'rpid',
                                 'sipconf_context_name' => 'myepusername_42',
                                 't38transport' => 'udptl',
                                 'usereqphone' => '1',
                                 'allowoverlap' => '1',
                                 'g729_silence_suppression' => '1',
                                 'session-minse' => '90',
                                 'timerb' => '32000',
                                 'insecure' => '1',
                                 'fromuser' => 'myfromuser',
                                 'enable_advanced' => '1',
                                 'g729_pr' => '20',
                                 'rtpholdtimeout' => '0',
                                 'fromdomain' => 'myfromdomain',
                                 'name' => '8005555555',
                                 'callingpres' => 'allowed_not_screened',
                                 'g726nonstandard' => '1',
                                 'port' => '1234',
                                 'dtmfmode' => 'auto',
                                 'honorsdpversion' => '1',
                                 'use_q850_reason' => '1',
                                 'transport' => [
                                                  'UDP',
                                                  'TCP'
                                                ],
                                 'session-refresher' => 'uas',
                                 'progressinband' => 'yes',
                                 'object_type' => 'sip_endpoint',
                                 'g722_pr' => '20',
                                 'timert1' => '500',
                                 'registration' => 'out',
                                 't1min' => '500ms',
                                 'auth' => '8005555555',
                                 'session-timers' => 'accept',
                                 'allowtransfer' => '1',
                                 'registertrying' => '1',
                                 'object_id' => 23,
                                 'gsm_pr' => '20',
                                 'alaw_pr' => '20',
                                 'ulaw_pr' => '20',
                                 'rtptimeout' => '0',
                                 'extension' => '100',
                                 'secret' => 'myeppassword',
                                 'codec_order' => [
                                                    {
                                                      'order' => '1',
                                                      'name' => 'ULAW',
                                                      'id' => 'ulaw'
                                                    },
                                                    {
                                                      'order' => '2',
                                                      'name' => 'ALAW',
                                                      'id' => 'alaw'
                                                    },
                                                    {
                                                      'order' => '3',
                                                      'name' => 'G722',
                                                      'id' => 'g722'
                                                    },
                                                    {
                                                      'order' => '4',
                                                      'name' => 'G726',
                                                      'id' => 'g726'
                                                    },
                                                    {
                                                      'order' => '5',
                                                      'name' => 'G729',
                                                      'id' => 'g729'
                                                    },
                                                    {
                                                      'order' => '6',
                                                      'name' => 'GSM',
                                                      'id' => 'gsm'
                                                    }
                                                  ],
                                 'host' => 'myephostname.example.tld',
                                 'g729_voice_detection' => '1',
                                 'defaultuser' => 'myepusername',
                                 'trustrpid' => '1',
                                 'promiscredir' => '1',
                                 'preferred_codec_only' => '1',
                                 'session-expires' => '1800',
                                 't38pt_udptl' => 'yes,redundancy,maxdatagram=400,tcf=local,ecmenable=yes',
                                 'max_forwards' => '70',
                                 'object_name' => 'phone',
                                 'qualify' => '1',
                                 'qualifyfreq' => '60',
                                 'rtpjittermode' => 'static',
                                 'rtpjitterdelay' => '50',                                 Â
                               }
                        }
        } |