PinnacleWhatsappPlugin 1.0.1

Pinnacle WhatsApp Plugin

Pinnacle WhatsApp plugin official library is useful for sending Outbound messages of all types (text, images, stickers, location pins, contact cards, audio, video, and templates). It can also be used for sending and fetching opt-in requests to the users, as well as the opted-in users list.

Note: API does not support Inbound APIs such as receiving messages from end clients though webhooks.

For API Key You will have to create an account with Pinnacle Teleservices PVT LTD. (https://console.pinbot.ai/) 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.

Session Messages

1. Send Text Message

{
  "from": "<Your Waba Number>",
  "to": "<Contact Number>",
  "type": "text",
  "message": {
    "text": "<Msg>"
  }
}

2. Send Image Message

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "image",
  "message": {
    "url": "<image url>",
    "caption": "<caption>",
    "filename": "<filename>"
  }
}

3. For Video Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "video",
  "message": {
    "url": "<video url>",
    "caption": "<caption>",
    "filename": "<filename>"
  }
}

4. For Interactive List Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "interactive",
  "message": {
    "interactive": {
      "type": "list",
      "header": {
        "type": "text",
        "text": "Test Header"
      },
      "body": {
        "text": "msgtext"
      },
      "footer": {
        "text": "Test Footer"
      },
      "action": {
        "button": "Button1",
        "sections": [
          {
            "title": "Section1",
            "rows": [
              {
                "id": "1",
                "title": "Row1",
                "description": "Desc1"
              }
            ]
          },
          {
            "title": "Section2",
            "rows": [
              {
                "id": "2",
                "title": "Row2",
                "description": "Desc2"
              }
            ]
          }
        ]
      }
    }
  }
}

5. For Interactive Button Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "interactive",
  "message": {
    "interactive": {
      "type": "button",
      "header": {
        "type": "text",
        "text": "this is header"
      },
      "body": {
        "text": "this is body"
      },
      "footer": {
        "text": "this is footer"
      },
      "action": {
        "buttons": [
          {
            "type": "reply",
            "reply": {
              "id": "1",
              "title": "Button 1"
            }
          },
          {
            "type": "reply",
            "reply": {
              "id": "2",
              "title": "Button 2"
            }
          }
        ]
      }
    }
  }
}

6. For Contact Card Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "contact",
  "message": {
    "contacts": {
      "name": {
        "first_name": "<first_name>",
        "last_name": "<last_name>"
      },
      "phones": [
        {
          "phone": "<phone>",
          "type": "<type>"
        },
        {
          "phone": "<phone>",
          "type": "<type>"
        }
      ]
    }
  }
}

7. For Current Location Messages.

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "location",
  "message": {
    "longitude": "<longitude>",
    "latitude": "<latitude>",
    "name": "<location name>",
    "address": "<location address>"
  }
}

8. For Sticker Messages.

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "sticker",
  "message": {
    "url": "<sticker URL>",
    "caption": "Test Sticker",
    "filename": "<filename>"
  }
}

Template Messages

Note: For Sending template messages we need to initiate the text message After that we can Send Template messages such as text, Image, video and document

1. Send Text Message

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "template",
  "message": {
    "templateid": "<template id>",
    "placeholders": ["<placeholders>"]
  }
}

2. For Sending Template Image Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "template",
  "message": {
    "templateid": "<template id>",
    "url": "<image url>",
    "placeholders": ["<placeholders>"]
  }
}

3. For Sending Template Video Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "template",
  "message": {
    "templateid": "<template id>",
    "url": "<video url>",
    "placeholders": ["<placeholders>"]
  }
}

4. For Sending Template Document Messages

{
  "from": "<wabanumber>",
  "to": "<contact number>",
  "type": "sticker",
  "message": {
    "url": "<sticker URL>",
    "caption": "Test Sticker",
    "filename": "<filename>"
  }
}

Common Function for calling the Plugin for Sending Message:

      string json = <JSON payload or JSON file > ;
      string jsonResult = JsonConvert.SerializeObject(json);
      string apikey ="<API Key>";
      string finalResult="";
             
       var payloadData = JsonConvert.DeserializeObject<payload>(jsonResult );

                if (payloadData.type.Trim() == "template")
                {
                   finalResult = obj.send_Whatsapp_Template_Messages(apikey, jsonResult );
                }
                else
                {
                   finalResult = obj.send_Whatsapp_Session_Messages(apikey, jsonResult );
                }

The following Response Message will be received

{
  "code": "200",
  "status": "SUCCESS",
  "message": "Message Processed Successfully",
  "data": {
    "messageid": "<messageid>"
  }
}

Request Body

Message Payload

Pinnacle Support

Call +91 83088 00004, +91 83088 00005 or email at support@pinnacle.in