pinnacle_sms_plugin

Pinnacle SMS plugin

Pinnacle sms plugin official library is useful to helps you in sending sms.

Installation

   npm install pinnacle_sms_plugin

Every function contains common parameters for authentication i.e. apikey You can provide apikey via request parameter to send SMS.

For API Key You will have to create an account with Pinnacle Teleservices PVT LTD. (https://console.pinnacle.in/) Once you create an account with Pinnacle you can obtain the api key from the email with all the credentials . The same can be used for your specific app or if you are testing with the sandbox application.

SEND SMS

Parameter Name	Parameter Description
apikey	It will be generated by admin and send to members as per requirement via email
Payload	It is a json payload.

Parameters

Parameter Name	Parameter Description
sender	Sender name must be 6 alpha characters and should be pre-approved by Pinnacle.
numbers	Comma-delimited list of mobile numbers in international format (i.e. 918123456789). Maximum of 10,000 numbers are allowed.
message	The message content. This parameter should be no longer than 2000 characters. The message also must be URL Encoded to support symbols like &.
messagetype	Message Type should be defined as per the type for example: TXT, UNI, USSD and etc.
scheduledate	This parameter can be used to specify a schedule date/time for your message, which should be provided in Unix timestamp format(YYYY-MM-DD HH:MM:SS). Times should be provided in GMT.
extrares	This parameter can be used to store extra parameters for your message, which should be provided as alphanumeric.
clientuid	This parameter can be used to store unique id sent by client.
dltentityid	This parameter can be used to store a DLT EntityID for your message.
dltheaderid	This parameter can be used to store a DLT HeaderID for your message.
dlttempid	This parameter can be used to store a DLT TemplateID for your message
dlttagid	This parameter can be used to store a DLT Consent ID for your message
tmid	This parameter is DLT Telemarketer ID for your message

1) Single number request

{
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxxx>",
      "text": "<Your Message>"
    }
  ],
  "messagetype": "TXT",
  "dlttempid": "<DLT Template ID>"
}

OR

{
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxxx>",
      "text": "<Your Message>"
    }
  ],
  "messagetype": "TXT",
  "dltentityid": "<DLT EntityID>",
  "dlttempid": "<DLT Template ID>",
  "dltheaderid": "<DLT Header ID>",
  "dlttagid": "<DLT Tag ID>",
  "tmid": "<Telemarketer ID>"
}

2) Multiple number request

{
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxx1>,<91xxxxxxxxx2>,<91xxxxxxxxx3>,......,<91xxxxxxxxxx>",
      "text": "<Your Message>"
    }
  ],
  "messagetype": "TXT",
  "dlttempid": "<DLT Template ID>"
}

3) Multiple number request with single template id

{
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxx1>",
      "text": "<Your Message 1>"
    },
    {
      "number": "<91xxxxxxxxx2>",
      "text": "<Your Message 2>"
    },
    {
      "number": "<91xxxxxxxxx3>",
      "text": "<Your Message 3>"
    }
  ],
  "messagetype": "TXT",
  "dlttempid": "<DLT Template ID>"
}

4) Multiple number request with multiple template id

 {
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxx1>",
      "text": "<Your Message 1>",
      "dlttempid": "<DLT Template ID 1>"
    },
    {
      "number": "<91xxxxxxxxx2>",
      "text": "<Your Message 2>",
      "dlttempid": "<DLT Template ID 2>"
    },
    {
      "number": "<91xxxxxxxxx3>",
      "text": "<Your Message 3>",
      "dlttempid": "<DLT Template ID 3>"
    }
  ],
  "messagetype": "TXT"
}

5) For regional language

For regional language we have to write "messagetype":"UNI".

{
  "sender": "<SENDER>",
  "message": [
    {
      "number": "<91xxxxxxxxxx>",
      "text": "<Your Message>"
    }
  ],
  "messagetype": "UNI",
  "dltentityid": "<DLT EntityID>",
  "dlttempid": "<DLT Template ID>",
  "dltheaderid": "<DLT Header ID>",
  "dlttagid": "<DLT Tag ID>",
  "tmid": "<Telemarketer ID>"
}

Pinnacle Support

Call [phone], [phone] or email at [e-mail]