Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

smppparam

August 17, 2023
Contributed by: 
C

Configuration for SMPP configuration parameters resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
clientmode Read-write Mode in which the client binds to the ADC. Applicable settings function as follows:
* TRANSCEIVER - Client can send and receive messages to and from the message center.
* TRANSMITTERONLY - Client can only send messages.
* RECEIVERONLY - Client can only receive messages.
Default value: TRANSCEIVER
Possible values = TRANSCEIVER, TRANSMITTERONLY, RECEIVERONLY
msgqueue Read-write Queue SMPP messages if a client that is capable of receiving the destination address messages is not available.
Default value: OFF
Possible values = ON, OFF
msgqueuesize Read-write Maximum number of SMPP messages that can be queued. After the limit is reached, the Citrix ADC sends a deliver_sm_resp PDU, with an appropriate error message, to the message center.
Default value: 10000
addrton Read-write Type of Number, such as an international number or a national number, used in the ESME address sent in the bind request.
Default value: 0
Minimum value = 0
Maximum value = 256
addrnpi Read-write Numbering Plan Indicator, such as landline, data, or WAP client, used in the ESME address sent in the bind request.
Default value: 0
Minimum value = 0
Maximum value = 256
addrrange Read-write Set of SME addresses, sent in the bind request, serviced by the ESME.
Default value: “\d*”

Operations

(click to see Properties)

UPDATE UNSET GET (ALL)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

update

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/smppparam

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"smppparam":{
"clientmode":<String_value>,
"msgqueue":<String_value>,
"msgqueuesize":<Double_value>,
"addrton":<Double_value>,
"addrnpi":<Double_value>,
"addrrange":<String_value>
}}

<!--NeedCopy-->

Response:

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

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/smppparam?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload: 


{"smppparam":{
"clientmode":true,
"msgqueue":true,
"msgqueuesize":true,
"addrton":true,
"addrnpi":true,
"addrrange":true
}}

<!--NeedCopy-->

Response:

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

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/smppparam

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "smppparam": [ {
"clientmode":<String_value>,
"msgqueue":<String_value>,
"msgqueuesize":<Double_value>,
"addrton":<Double_value>,
"addrnpi":<Double_value>,
"addrrange":<String_value>
}]}

<!--NeedCopy-->
smppparam
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.