External SIP Peer



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/ext-sip-peer

Summary


Resources Methods
https://localhost:8443/api/rest/ext-sip-peer

GET Retrieves External SIP Peers.

POST  Creates a SIP Peer object.

https://localhost:8443/api/rest/ext-sip-peer/test-options

POST  Test SIP OPTIONS request.

https://localhost:8443/api/rest/ext-sip-peer/debug-postliminary

POST  Test an external SIP peer postliminary script.

https://localhost:8443/api/rest/ext-sip-peer/postliminary-script

GET  Returns the plcm-postliminary-script.

https://localhost:8443/api/rest/ext-sip-peer/status

GET Retrieves External SIP Peers.

https://localhost:8443/api/rest/ext-sip-peer/{value}

GET Retrieves an External SIP Peer.

PUT  Updates a SIP peer.

DELETE Deletes a SIP Peer.

https://localhost:8443/api/rest/ext-sip-peer/defaults

GET Retrieves default values for external sip peers.

Resources


https://localhost:8443/api/rest/ext-sip-peer


Methods

GET

Retrieves External SIP Peers. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-ext-sip-peer-list+xml
application/vnd.plcm.plcm-ext-sip-peer-list+json
application/vnd.plcm.plcm-ext-sip-peer-list-v2+xml
application/vnd.plcm.plcm-ext-sip-peer-list-v2+json
application/vnd.plcm.plcm-ext-sip-peer-list-v3+xml
application/vnd.plcm.plcm-ext-sip-peer-list-v3+json
application/vnd.plcm.plcm-ext-sip-peer-list-v4+xml
application/vnd.plcm.plcm-ext-sip-peer-list-v4+json
Information successfully retrieved
304
External SIP Peers information has not changed since the last search.

Note: The API client must provide the "plcm-ext-sip-peer-list"
representation's ETag value in the "If-None-Match" HTTP header to
ensure conditional retrieval. This will improve network performance
by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP
response will contain the search results in the message body.

The "plcm-ext-sip-peer-list" ETag can be accessed from the initial
search result's HTTP response header. Also, subsequent searches
require the identical search filter to ensure an equivalent ETag
value. This also assumes no other client made changes to
External SIP Peers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator,
provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
SIP Peer not found. There are no SIP Peers stored.

POST


Creates a SIP Peer object. Any submitted ID is ignored.
The ID is assigned by the system.

Name and SIP Peer address are required, and name must be unique.
If a SIP Peer pre-exists with a similar name the request fails.

DMA role required: administrator.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-sip-peer+xml
application/vnd.plcm.plcm-ext-sip-peer+json
application/vnd.plcm.plcm-ext-sip-peer-v2+xml
application/vnd.plcm.plcm-ext-sip-peer-v2+json
application/vnd.plcm.plcm-ext-sip-peer-v3+xml
application/vnd.plcm.plcm-ext-sip-peer-v3+json
application/vnd.plcm.plcm-ext-sip-peer-v4+xml
application/vnd.plcm.plcm-ext-sip-peer-v4+json

Response

Status Representation Description
201
SIP Peer created successfully. The ETag returned in the HTTP header
represents the version of the SIP Peer.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
External SIP Peer with that name already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The name of the external peer is required. The name must be between 1 and 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer address is required and must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer description must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual address of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
System itself can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The cluster node of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Supercluster node can't be configured as external peer.luster node of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #pport# is used in postliminary, but the port has not been configured yet. Please configure the port first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #ptransport# is used in postliminary, but the transport has not been configured yet. Please configure the transport first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #pscheme# is used in postliminary, but the transport has not been configured yet. Please configure the transport first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Selecting free form contact type requires configuration of a free form address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The address of record is not a properly formatted SIP URI.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
You should input at least one authentication item when you enable proxy authentications.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The transport type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The postliminary To Header format value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The postliminary Request URI format value is invalid. Try reading the sip peer with newer versions of the API.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The outbound registration contact address format value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Transport type is required. Auto detection is to find proper transport
type by looking up the DNS server, and only works with domain address, not IP address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The destination network must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer port number must be in the range 1024 - 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Destination network is required for Microsoft.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The prefix range value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The domain name is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
All outbound SIP authentications must have a non-blank realm, username, and password.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If an outbound registration password is specified a username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Outbound registration password must not be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
All outbound registrations must include a territory value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The value of the passback attribute must be less than 512 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync account URI is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync MCU pool order cannot be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync MCU pool order not allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync account URI not allowed.

https://localhost:8443/api/rest/ext-sip-peer/test-options


Methods

POST


Test SIP OPTIONS request. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-sip-peer+xml
application/vnd.plcm.plcm-ext-sip-peer+json

Response

Status Representation Description
200 SIP Peer at specific address responded to SIP OPTIONS request and is available.
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid hostname or IP address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Hostname or IP address cannot be blank

https://localhost:8443/api/rest/ext-sip-peer/debug-postliminary


Methods

POST


Test an external SIP peer postliminary script.
It lets you specify parameters of a call and the dial string and see what effect the script has on the dial string.
This test is a dry run, and has no effect other than to show what would happen given a set of values.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+json
The debug session was completed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/ext-sip-peer/postliminary-script


Methods

GET


Returns the plcm-postliminary-script.xml, which contains the translated script, built from supplied
toHeaderTemplate and requestURITemplate. If one (or both) of these query parameters is not provided, the default value
will be used.
Default value for toHeaderTemplate: "#otdisplay# #otscheme#:#otuser#@#othost#"
Default value for requestURITemplate: "#pscheme#:#oruser#@#phost#"
[tags: DMA]

Request

Query Parameters

Name Type Description
toHeaderTemplate xs:string
Specifies the To Header option.
requestURITemplate xs:string
Specifies the Request URI option.

Response

Status Representation Description
200 application/vnd.plcm.plcm-postliminary-script+xml
application/vnd.plcm.plcm-postliminary-script+json
The translated script is returned

https://localhost:8443/api/rest/ext-sip-peer/status


Methods

GET

Retrieves External SIP Peers. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-ext-sip-peer-list-v4+xml
application/vnd.plcm.plcm-ext-sip-peer-list-v4+json
Information successfully retrieved
304
External SIP Peers information has not changed since the last search.

Note: The API client must provide the "plcm-ext-sip-peer-list"
representation's ETag value in the "If-None-Match" HTTP header to
ensure conditional retrieval. This will improve network performance
by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP
response will contain the search results in the message body.

The "plcm-ext-sip-peer-list" ETag can be accessed from the initial
search result's HTTP response header. Also, subsequent searches
require the identical search filter to ensure an equivalent ETag
value. This also assumes no other client made changes to
External SIP Peers on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator,
provisioner
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
SIP Peer not found. There are no SIP Peers stored.

https://localhost:8443/api/rest/ext-sip-peer/{value}


Template Parameters

Name Type Description
value xs:string Unique identifier of the External SIP Peer

Methods

GET

Retrieves an External SIP Peer. [tags: DMA]

Request

Query Parameters

Name Type Description
type xs:string
Specifies an enumerated type that will indicate that the resource should
be read by its immutable, unique identifier: name or ID.

The URL form is
https://{host}:{port}/api/rest/{resource}/{identifier}

Response

Status Representation Description
200 application/vnd.plcm.plcm-ext-sip-peer+xml
application/vnd.plcm.plcm-ext-sip-peer+json
application/vnd.plcm.plcm-ext-sip-peer-v2+xml
application/vnd.plcm.plcm-ext-sip-peer-v2+json
application/vnd.plcm.plcm-ext-sip-peer-v3+xml
application/vnd.plcm.plcm-ext-sip-peer-v3+json
application/vnd.plcm.plcm-ext-sip-peer-v4+xml
application/vnd.plcm.plcm-ext-sip-peer-v4+json
Information successfully retrieved
304
External SIP Peer information has not changed since the last search.

Note: The API client must provide the "plcm-ext-sip-peer" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional
retrieval. This will improve network performance by reducing bandwidth
consumption.

If the API client chooses to exclude an ETag value from a previous,
identical search in the "If-None-Match" header, then the HTTP response will
contain the search results in the message body.

The "plcm-ext-sip-peer" ETag can be accessed from the initial search
result's HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other
client made changes to the External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such External SIP Peer

PUT


Updates a SIP peer.

DMA role required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-sip-peer+xml
application/vnd.plcm.plcm-ext-sip-peer+json
application/vnd.plcm.plcm-ext-sip-peer-v2+xml
application/vnd.plcm.plcm-ext-sip-peer-v2+json
application/vnd.plcm.plcm-ext-sip-peer-v3+xml
application/vnd.plcm.plcm-ext-sip-peer-v3+json
application/vnd.plcm.plcm-ext-sip-peer-v4+xml
application/vnd.plcm.plcm-ext-sip-peer-v4+json

Response

Status Representation Description
204
SIP Peer updated successfully. The ETag returned in the HTTP header represents the current version
of the SIP Peer.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no template with the identifier supplied in the URL and/or the body of the request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ID supplied in the URL and/or the body of the request cannot be parsed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ID supplied in the URL does not match that supplied in the body of the request.
Only one of these is required but if they are both supplied they must match.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag supplied in the header and/or body does not match that on the server.
This usually means that the template upon which the update is based has changed
since the last time you accessed it.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ETag is missing and required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag in the header does not match that in the body
Only one of these is required but if they are both supplied they must match.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name already used. Since the template to be updated is identified by identifier, not name, the name
may be changed, but not to a name that is already taken by another template.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The name of the external peer is required. The name must be between 1 and 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer address is required and must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer description must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The virtual address of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
System itself can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The cluster node of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Supercluster node can't be configured as external peer.luster node of this server can't be configured as external peer.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #pport# is used in postliminary, but the port has not been configured yet. Please configure the port first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #ptransport# is used in postliminary, but the transport has not been configured yet. Please configure the transport first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Variable #pscheme# is used in postliminary, but the transport has not been configured yet. Please configure the transport first.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Selecting free form contact type requires configuration of a free form address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The address of record is not a properly formatted SIP URI.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
You should input at least one authentication item when you enable proxy authentications.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The transport type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The postliminary To Header format value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The postliminary Request URI format value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The outbound registration contact address format value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Transport type is required. Auto detection is to find proper transport
type by looking up the DNS server, and only works with domain address, not IP address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The destination network must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer port number must be in the range 1024 - 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP Peer type value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Destination network is required for Microsoft.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The prefix range value is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The domain name is invalid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
All outbound SIP authentications must have a non-blank realm, username, and password.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If an outbound registration password is specified a username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Outbound registration password must not be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
All outbound registrations must include a territory value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The value of the passback attribute must be less than 512 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync account URI is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync MCU pool order cannot be found.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync MCU pool order not allowed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Lync account URI not allowed.

DELETE

Deletes a SIP Peer. [tags: DMA]

Request

Response

Status Representation Description
204 SIP Peer deleted successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no SIP Peer with the identifier supplied in the URL.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ID supplied in the URL cannot be parsed.

https://localhost:8443/api/rest/ext-sip-peer/defaults


Methods

GET

Retrieves default values for external sip peers.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-ext-sip-peer-defaults+xml
application/vnd.plcm.plcm-ext-sip-peer-defaults+json
Successfully
403 application/vnd.plcm.plcm-error+xml
Unable to get permission.