Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: PUT /rest/sipservertable/{identifier}/sipserver/{identifier}

sipserver - REST API Methods
Page Tree
rootResource - sipserver

Creates a SIP Server Table Entry given a specific Table Entry ID in a given SIP Server Table.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/sipservertable/{identifier}/sipserver/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[sipserver - REST API Methods|Resource - sipserver]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ServerLookupYesNoEnum0Possible values:
  • 0 - eLkUpIpFQDN
  • 1 - eLkUpSRV
 Specifies the method to use to lookup SIP servers
  • IP/FQDN
    - Do a typical DNS lookup of FQDN.
  • DNS SRV
    - Send an SRV record to DNS server then upon reply lookup FQDN's via DNS.
A maximum of 99 entries can be added to this table entry. When added via REST any Row ID greater than 99 will be rejected.
ServerTypeYesNoEnum0Possible values:
  • 0 - eConventionalSrvr
  • 1 - eSrvRecordTemplateSrvr
  • 2 - eSrvRecordSrvr
 Specifies the method to use to lookup SIP servers
  • eConventionalSrvr
    - A configured server entry defined by IP or FQDN.
  • eSrvRecordTemplateSrvr
    - This is not an actual server but a template which will populate the server(s) once the SRV Query gets a response from DNS.
  • eSrvRecordSrvr
    - The actual server created after SRV Query.
WeightYesNoint0Possible values:
  • 0 - Minimum
  • 65535 - Maximum
 Specifies the weight of the server in case it's defined in the SRV record.
HostYesNostringnone256 - Max Length Specifies the IP address or FQDN where this Signaling Group sends SIP messages. If an FQDN is configured all the associated servers are included and used according to the server selection configuration element.
HostIpVersionYesNoEnum0Possible values:
  • 0 - eVersionPreferIPv4
  • 1 - eVersionPreferIPv6
 Specifies whether the FQDN should be resolved into IPv4 addresses or IPv6 addresses. If this is a SRV record, this field specifies whether the resulting FQDNs are resolved into IPv4 or IPv6 addresses. By default, the SBC resolves the FQDN into IPv4 addresses.
DomainNameYesNostringnone256 - Max Length Specifies the Domain where this Signaling Group sends SRV queries.
ServiceNameNoNostringsip64 - Max LengthThe name of the service to be placed in the SRV request.
PortYesYesint5060Possible values:

    ...

    • 1 - Minimum
    • 65535 - Maximum
    		Specifies the port number to send SIP messages.
    TransportSocketNoNoint0Possible values:
    • 0 - Minimum

    ...

    • 10 - Maximum
    		 Specifies number of re-usable sockets
    Info

    This option is available when ReuseTransport is set to True. When ReuseTransport is false, this needs to be set to 0

    ReuseTransportNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		Specifies whether sockets will be reused or shared. Only valid for TCP or TLS
    ReuseTimeoutNoNoint1000Possible values:
    • 0 - Minimum
    • 1440 - Maximum
    		 Specifies the number of minutes that a socket remains connected to the server.
    Info

    This option is available when ReuseTransport is Enabled. A value of 0 means ReuseTimeout is set Forever*. Otherwise, the valid range is 5-1440

    ProtocolYesNoEnum1Possible values:
    • 0 - eTrNone
    • 1 - eTrUDP
    • 2 - eTrTCP
    • 3 - eTrTCP_UDP
    • 4 - eTrTLS
    • 5 - eTrTLS_UDP
    • 6 - eTrTLS_TCP
    • 7 - eTrTLS_TCP_UDP
    • 8 - eTrCount
    • 9 - eTrSCTP
    		 Specifies the protocol to use for sending SIP messages
    • UDP
      - Send messages using UDP.
    • TCP
      - Send message using TCP.
    • TLS
      - Send message using TLS.
    MonitorNoNoEnum0Possible values:
    • 0 - eMonitorNone
    • 1 - eMonitorOptions
    • 2 - eMonitorPing
    		 Specifies the method to monitor server
    • None
      - no monitoring of this server occurs
    • SIP options
      - an Options message is sent to the server
    KeepAliveFrequencyNoNoint30Possible values:
    • 0 - Minimum
    • 300 - Maximum
    		Specify frequency in seconds to determine server availability.
    Info

    This configuration is available when Monitor is set to SIP Options . If Monitor is not set to SIP Options, this value needs to be 0. Otherwise, this value needs to be in the range 30-300*

    RecoverFrequencyNoNoint5Possible values:
    • 0 - Minimum
    • 300 - Maximum
    		Specify frequency in seconds to check server to determine whether it has become available.
    Info

    This configuration is available when Monitor is set to SIP Options . If Monitor is not set to SIP Options, this value needs to be 0. Otherwise, this value needs to be in the range 5-300*

    LocalUserNameNoNostringAnonymous64 - Max LengthThe local username of the

    ...

    SBC

    ...

    .
    Info

    This configuration is available when Monitor is set to SIP Options

    PeerUserNameNoNostringAnonymous64 - Max LengthThe username of SIP server.
    Info

    This configuration is available when Monitor is set to SIP Options

    PriorityYesNoint0Possible values:
    • 0 - Minimum
    • 16 - Maximum
    		Specifies the priority of this server. The priority is used to order the server when more than 1 is configured.
    RemoteAuthorizationTableIDNoNoint0Possible values:
    • 0 - Minimum
    • 65534 - Maximum
    		 Specifies a Remote Authorization table for this SIP Server, from a list of authorization tables defined in the Remote Authorization Tables. The Remote Authorization table is used by a Signaling group when a challenge (401/407) is issued by the server. The table contains a realm, user name, and password. There are used to provide credentials to he server issuing the challenge.
    ContactRegistrantTableIDNoNoint0Possible values:
    • 0 - Minimum
    • 65534 - Maximum
    		 Specifies a Contact Registration Table for this SIP Server,from a list of registration tables defined in the Contact Registrant Tables. The Contact Registration is used by a Signaling Group to register one or more contacts to a registrar. The contact information contains the SIP address of record and the methods which can be used to establish sessions to this Signaling group.
    StaggerRegistrationNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 If more than one Contact Registrant Entry is in Contact table, stagger Register Requests by 1 second. Applies to UnRegister also. This will only be displayed and applicble if Contact Registract Table is something other than None.
    ClearRemoteRegistrationOnStartupNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 When enabled, a Register with Expires: 0 will be sent to the SIP Server on power up. After the Unregister (Expires: 0) is complete, a Register (Expires: non-zero) will then be sent.
    SessionURIValidationNoNoEnum0Possible values:
    • 0 - edsLiberal
    • 1 - edsStrict
    		Selects whether the Request URI of the incoming request needs to be validated. edsStrict ensures that the request URI is validated, edsLiberal ensures no validation is done.
    ContactURIRandomizerNoNoEnum0Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 If enabled, the following will occur: -Random user values will be generated and put into the Contact-URI of each outgoing Register message. -The random user portion will be saved and compared to incoming Invite Request-Uri's. If the prefix of the R-URI contains SBCxxxx, then if there is a match, SBCxxxx will be stripped and the remaining number used to route (if no match, Invite is not accepted). If there is no SBCxxxx in R-URI, then the number is sent as-is for routing.
    RetryNonStaleNonceNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 This value will only be visible if

    ...

    Remote Authorization Table are defined in SIP Server. When true, if stale=false is received in 401/407, the SBC will set failed retry timer and re-attempt to send Register with same credentials at expiration. When false, if stale=false is received in 401/407, the SBC will never resend a

    ...

    challenged request with the same credentials.(this is RFC behavior)
    TLSProfileIDNoNoint0Possible values:
    • 0 - Minimum
    • 65534 - Maximum
    		 If TLS is selected this specifies the TLS profile this server will use for secure SIP messages.
    Info

    This option is available if Protocol is set to TLS.

    Usage Example: (about cURL | requires a session token)

    Code Block
    languagebash
    curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44 -s -k -i https://134.56.72.218/rest/sipservertable/1/sipserver/1 -X PUT --data "ContactURIRandomizer=0&ConfigIEState=1&KeepAliveFrequency=30&Host=192.168.200.1&RecoverFrequency=5&ClearRemoteRegistrationOnStartup=0&RemoteAuthorizationTableID=0&ReuseTimeout=0&ServiceName=sip&Weight=0&TLSProfileID=0&Monitor=1&DomainName=&ServerType=0&Protocol=1&TransportSocket=4&RetryNonStaleNonce=1&ReuseTransport=1&ServerLookup=0&Priority=1&ContactRegistrantTableID=0&Port=5060&PeerUserName=Anonymous&LocalUserName=Anonymous&StaggerRegistration=0"

    Response:

    ...

    languagehtml/xml

    ...

    AuthorizationOnRefreshNoNoEnum1Possible values:
    • 0 - btFalse
    • 1 - btTrue
    		 This value will only be visible if both Contact Registrant Table and Remote Authorization Table are defined in SIP Server. When true, the SBC will include authorization headers obtained from previous 401/407 exchange in registration refresh messages. When false, the SBC will not include authorization headers obtained from previous 401/407 exchange in registration refresh messages.

    ...