plugin.json

{
  "name": "nexmo_converseai",
  "displayName": "Nexmo",
  "description": "Nexmo plugin providing access to cloud communications functionality",
  "category": "",
  "documentLink": "",
  "needsOAuth": false,
  "providerData": [
    {
      "param": "api_key",
      "displayName": "Api Key",
      "description": "API Key",
      "type": "STRING",
      "optional": false
    },
    {
      "param": "api_secret",
      "displayName": "Api Secret",
      "description": "API Secret",
      "type": "PASSWORD",
      "optional": false
    },
    {
      "param": "application_id",
      "displayName": "Application Id",
      "description": "Nexmo Application ID",
      "type": "TEXT",
      "optional": true
    },
    {
      "param": "application_private_key",
      "displayName": "Nexmo Application Private Key",
      "description": "Nexmo Application Private Key",
      "type": "STRING",
      "optional": true
    }
  ],
  "module": [
    {
      "id": "send_sms",
      "name": "Send SMS Message",
      "description": "Send an SMS message via Nexmo",
      "hasReturn": true,
      "param": [
        {
          "param": "from",
          "displayName": "From",
          "description": "The phone number or alphanumeric sender ID the SMS is being sent from",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "to",
          "displayName": "To",
          "description": "The phone number the SMS is to be sent to",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "text",
          "displayName": "Text",
          "description": "The message text to be sent in the SMS",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "unicode",
          "displayName": "Unicode",
          "description": "A flag to indicate if the message contains special characters",
          "type": "BOOLEAN",
          "optional": true
        }
      ]
    },
    {
      "id": "send_verify_pin_code",
      "name": "Send Verify PIN Code",
      "description": "Send a Verify PIN code to start the phone number verification process",
      "hasReturn": true,
      "param": [
        {
          "param": "number",
          "displayName": "Number",
          "description": "The phone number that the PIN code is to be sent to.",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "country",
          "displayName": "Country",
          "description": "If do not set number in international format or you are not sure if number is correctly formatted, set country with the two-character country code. For example, GB, US. Verify works out the international phone number for you.",
          "type": "STRING",
          "optional": true
        },
        {
          "param": "brand",
          "displayName": "Brand",
          "description": "The name of the company or App you are using Verify for. This 18 character alphanumeric string is used in the body of Verify message. For example: \"Your brand PIN is ..\".",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "sender_id",
          "displayName": "Sender Id",
          "description": "An 11 character alphanumeric string to specify the SenderID for SMS sent by Verify. Depending on the destination of the phone number you are applying, restrictions may apply. By default, sender_id is VERIFY.",
          "type": "STRING",
          "optional": true
        },
        {
          "param": "code_length",
          "displayName": "Code Length",
          "description": "The length of the PIN. Possible values are 6 or 4 characters. The default value is 4.",
          "type": "NUMBER",
          "optional": true
        },
        {
          "param": "language",
          "displayName": "Language",
          "description": "By default, the SMS or text-to-speech (TTS) message is generated in the locale that matches the number. For example, the text message or TTS message for a 33* number is sent in French. Use this parameter to explicitly control the language, accent and gender used for the Verify request. The default language is en-us.",
          "type": "STRING",
          "optional": true
        },
        {
          "param": "pin_expiry",
          "displayName": "PIN Expiry",
          "description": "The PIN validity time from generation. This is an integer value between 60 and 3600 seconds. The default is 300 seconds. When specified together, pin_expiry must be an integer multiple of nextEventWaitSeconds. Otherwise, pin_expiry is set to equal nextEventWaitSeconds.",
          "type": "NUMBER",
          "optional": true
        },
        {
          "param": "next_event_wait_seconds",
          "displayName": "Next Event Wait Seconds",
          "description": "An integer value between 60 and 900 seconds inclusive that specifies the wait time between attempts to deliver the PIN. Verify calculates the default value based on the average time taken by users to complete verification.",
          "type": "NUMBER",
          "optional": true
        }
      ]
    },
    {
      "id": "check_verify_pin_code",
      "name": "Check Verify PIN Code",
      "description": "Check a Nexmo Verification PIN Code",
      "hasReturn": true,
      "param": [
        {
          "param": "request_id",
          "displayName": "Request ID",
          "description": "A unique ID for an active verify request",
          "type": "STRING",
          "optional": false
        },
        {
          "param": "pin_code",
          "displayName": "PIN Code",
          "description": "The PIN given by your user to be checked",
          "type": "STRING",
          "optional": false
        }
      ]
    }
  ],
  "hasOAuth": false
}