Versions Compared

Key

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

REST API Method: PUT /rest/sipcontactregistrant/{identifier}/sipregistrantentry/{identifier}

Page Tree
rootResource - sipregistrantentry

Creates a SIP Contact Registrant Entry with a specific Entry ID in a SIP Contact Registrant Table.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/sipcontactregistrant/{identifier}/sipregistrantentry/{identifier}

HTTP Method

PUT

Requires Authentication:

true

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

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
AorTypeNoNoEnum1Possible values:
  • 0 - e_HostNone
  • 1 - e_HostLocal
  • 2 - e_HostRemote
  • 3 - e_HostStatic
URI Host Type. Local: Host will be the local IP/FQDN and will use SIP Profile for From Header format. Format of AOR field-> protocol:user Remote: Host will be the Server IP and will use SIP Profile for From header field. Format of AOR field->protocol:user Static: Allow user to enter the full AOR and use this in to/from headers. * Will not use the SIP Profile. Format of AOR field-> protocol:user@host
AORYesNostringnone512 - Max Length Identifies the address of record for this client to be registered to the SIP server. If Type of Address of Record is set to Static, the URI must contain protocol:user@host, for example: sip:17324609000@remoterserver.com
AorTtlNoNoint

...

3600Specifies how long contacts registered are valid. The global TTL applies to all contacts registered unless an individual contact contains a seperate time to live.
FailedRegistrationRetryTimerYesNoint120Possible values:
  • 30 - Minimum
  • 86400 - Maximum
Interval to wait after a failed outgoing registration to try again. In seconds.
TTL1NoNoint

...

64Time To Live value.
Q1NoNoint100q-value, priority for processing order, value from 0 to 100.
URI1NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL2NoNoint

...

64Time To Live value.
Q2NoNoint100q-value, priority for processing order, value from 0 to 100.
URI2NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL3NoNoint

...

64Time To Live value.
Q3NoNoint100q-value, priority for processing order, value from 0 to 100.
URI3NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL4NoNoint

...

64Time To Live value.
Q4NoNoint100q-value, priority for processing order, value from 0 to 100.
URI4NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL5NoNoint

...

64Time To Live value.
Q5NoNoint100q-value, priority for processing order, value from 0 to 100.
URI5NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL6NoNoint

...

64Time To Live value.
Q6NoNoint100q-value, priority for processing order, value from 0 to 100.
URI6NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL7NoNoint

...

64Time To Live value.
Q7NoNoint100q-value, priority for processing order, value from 0 to 100.
URI7NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.
TTL8NoNoint

...

64Time To Live value.
Q8NoNoint100q-value, priority for processing order, value from 0 to 100.
URI8NoNostringnone512 - Max LengthUniform Resource Identifier(URI),SIP URI per RFC3261.

...

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

Code Block
languagebash
Put code example here

Response:

...

languagehtml/xml

...