Download full document:

lsnsipalgcall_datachannel_binding

Binding object showing the datachannel that can be bound to lsnsipalgcall.

Properties

(click to see Operations)

NameData TypePermissionsDescription
channelip<String>Read-writeIP address of the channel.
callid<String>Read-writeCall ID for the SIP call.
channelnatip<String>Read-onlyNatted IP address of the channel.
channelport<Integer>Read-onlyport for the channel.
channelflags<Double>Read-onlyFlags for the call entry.
channeltimeout<Double>Read-onlyTimeout for the channel.
channelnatport<Integer>Read-onlyNatted port for the channel.
channelprotocol<String>Read-onlyChannel transport protocol.
Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, HTTPSVR, HTTPCLIENT, NAT, HA, AAA, SINCTCP, VPN AFTP, MONITORS, SSLVPN UDP, SINCUDP, RIP, UDP CLNT, SASP, RPCCLNTS, ROUTE, AUDIT, STA HTTP, STA SSL, DNS RESOLVE, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, ICA, RADIUS, RADIUSListener, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, QUIC, TFTP_DATA, USER_TCP, USER_SSL_TCP
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

GET| GET (ALL)| COUNT

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note:In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in redand placeholder content is marked in <green>.

get

URL:http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding/callid_value<String>

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding/callid_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of lsnsipalgcall_datachannel_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

pagination

http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding/callid_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the lsnsipalgcall_datachannel_binding resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lsnsipalgcall_datachannel_binding": [ {
"channelip":<String_value>,
"callid":<String_value>,
"channelnatip":<String_value>,
"channelport":<Integer_value>,
"channelflags":<Double_value>,
"channeltimeout":<Double_value>,
"channelnatport":<Integer_value>,
"channelprotocol":<String_value>
}]}

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "lsnsipalgcall_datachannel_binding": [ {
"channelip":<String_value>,
"callid":<String_value>,
"channelnatip":<String_value>,
"channelport":<Integer_value>,
"channelflags":<Double_value>,
"channeltimeout":<Double_value>,
"channelnatport":<Integer_value>,
"channelprotocol":<String_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/lsnsipalgcall_datachannel_binding/callid_value<String>?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{"lsnsipalgcall_datachannel_binding": [ { "__count": "#no"} ] }