Config for smpp

Jobs that use the smpp adaptor may require authentication. A "credential" for the smpp adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "clientHost": "https://some-smpp.com:3000",
  "systemId": "some_smpp_client_name",
  "inboxId": "1c908151-8273-431c-b1d4-blah",
  "password": "@some(!)StrongPassword"
}

Full Schema

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "clientHost": {
          "title": "Client host",
          "type": "string",
          "description": "Your SMPP client host URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://some-smpp.com:3000"
          ]
      },
      "systemId": {
          "title": "System ID",
          "type": "string",
          "description": "Your SMPP client name",
          "minLength": 1,
          "examples": [
              "some_smpp_client_name"
          ]
      },
      "inboxId": {
          "title": "Inbox ID",
          "type": "string",
          "description": "Your SMPP client inbox ID",
          "minLength": 1,
          "examples": [
              "1c908151-8273-431c-b1d4-blah"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Your SMPP client password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some(!)StrongPassword"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "clientHost",
      "systemId",
      "inboxId",
      "password"
  ]
}