Push SMS Settings (GET)

Retrieves SMS settings for the application

Method

GET

Path

/apps/applicationId/settings/smsConf

Example

https://example.com:443/imfpush/v1/apps/myapp/settings/smsConf

Path Parameters

applicationId
The name or identifier of the application

Header Parameters

Some header parameters are optional.

Accept-Language
(Optional) The preferred language to use for error messages. Default:en-US
Authorization
The token with the scope "smsConf.read" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Produces

application/json

Response

Retrieves SMS settings for the application.

JSON Example

{
  "host" : "xyz.com",
  "name" : "TestGateway",
  "parameters" : [
    {
      "encode" : "true",
      "name" : "TestKey",
      "value" : "TestValue",
    },
    ...
  ],
  "port" : "80",
  "programName" : "/sendsms",
}

Response Properties

The response has the following properties:

host
The host name of the SMS Gateway
name
The name of the SMS Gateway
parameters
The array of parameters
port
The port number of the SMS Gateway
programName
The path of the SMS Gateway

The parametersArray has the following properties:

encode
The parameter should be encoded or not
name
The name of the parameter
value
The value of the parameter

Errors

401
Unauthorized - The caller is either not authenticated or not authorized to make this request.
404
The application does not exist.
406
Unsupported Accept type - The content type specified in Accept header is not application/json.
500
An internal error occurred.