For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Push SMS Settings (PUT)

Updates SMS settings referenced by the applicationId

Method

PUT

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.write" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Content-Type

Specify the content type. For example: application/json. This parameter has to be mandatorily set.

Consumes

application/json

Produces

application/json

Payload

The details of the sms settings.

JSON Example

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

Payload Properties

The payload 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

Response

Successfully updated the SMS settings.

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

400

Bad Request - The request was not understood by the push server. An invalid data in the input.

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.

Parent topic: REST API for the MobileFirst Server push service