Creates an app integration SMS

Creates a new app integration SMS.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

Provides a data transfer object for the SMS integration which is used for command requests.

appIntegrationIdstring · min: 1Required

The app integration provider ID of the SMS.

namestring · min: 1Required

The name of the SMS integration.

usernamestring · min: 1Required

The username or identifier for the SMS integration. For Twilio, this is the Account SID (String Identifier).

passwordstring · min: 1Required

The password or authentication token for the SMS integration. For Twilio, this is the Auth Token.

phoneNumberstring · min: 1Required

The phone number of the SMS integration. The phone number should be following the E.164 format.

descriptionstring | nullableOptional

The description of the SMS integration.

statusstring · enumOptional

This enum is used to define the common status of an object in JFW.

Supported values:

Possible values:

isDefaultbooleanOptional

Flag to indicate if the app integration SMS setting is default. By default, it is false.

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/sms HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 156

{
  "appIntegrationId": "text",
  "name": "text",
  "username": "text",
  "password": "text",
  "phoneNumber": "text",
  "description": "text",
  "status": "Inactive",
  "isDefault": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "name": "SMS Integration",
    "username": "smsuser",
    "password": "smspassword",
    "phoneNumber": "[phone]",
    "description": "This is an example SMS integration",
    "status": "Active",
    "isDefault": true,
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}