Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/backaged/instabot
Instagram Messaging API GO SDK
https://github.com/backaged/instabot
go go-instagram go-instagram-sdk golang instagram instagram-api instagram-bot sdk sdk-go
Last synced: about 16 hours ago
JSON representation
Instagram Messaging API GO SDK
- Host: GitHub
- URL: https://github.com/backaged/instabot
- Owner: BackAged
- License: mit
- Created: 2021-08-13T12:45:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-12T12:37:05.000Z (over 2 years ago)
- Last Synced: 2024-06-20T13:28:16.371Z (8 months ago)
- Topics: go, go-instagram, go-instagram-sdk, golang, instagram, instagram-api, instagram-bot, sdk, sdk-go
- Language: Go
- Homepage: https://developers.facebook.com/docs/messenger-platform/instagram
- Size: 48.8 KB
- Stars: 36
- Watchers: 7
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Instagram Messaging API GO SDK
[](https://github.com/BackAged/instabot/actions/workflows/go.yaml)
[](https://codecov.io/gh/BackAged/instabot)
[](http://godoc.org/github.com/BackAged/instabot)
[](https://goreportcard.com/report/github.com/BackAged/instabot)
[](https://github.com/BackAged/instabot/actions/workflows/codeql-analysis.yaml)
[](https://repl.it/github/BackAged/instabot)
## Introduction
Instabot, Instagram Messaging API GO SDK makes it easy to work with instagram messaging API.
It uses Instagram messaging API latest version - `v11.0`
## Requirements
Instabot requires Go 1.13 or later.
## Installation ##
```sh
$ go get -u github.com/BackAged/instabot
```
## Instabot configuration
```go
import (
"context"
"fmt"
"log"
"github.com/BackAged/instabot"
)
func main() {
// instantiating instabot.
bot, err := instabot.New("your_instagram_business_account_page_access_token")
...
// instantiating with http.Client
bot, err := instabot.New(
"your_instagram_business_account_page_access_token",
instabot.WithHTTPClient(yourHttpClient)
)
...
// instantiating with mock api server
bot, err := instabot.New(
"your_instagram_business_account_page_access_token",
instabot.APIEndpointBase("http://your_mock_api_server.com")
)
...
}
```
## Example
```go
import (
"context"
"fmt"
"log"
"github.com/BackAged/instabot"
)
func main() {
// See examples directory for more example.
// instantiating instabot.
bot, err := instabot.New("your_instagram_business_account_page_access_token")
...
// Send text message.
_, err = bot.SendMessage(
context.Background(),
"instagram_user_id_you_want_to_send_message_to",
instabot.NewTextMessage("hello"),
)
...
// Set icebreakers
_, err = bot.SetIceBreakers(
context.Background(),
[]*instabot.IceBreaker{
instabot.NewIceBreaker("frequently asked question 1", "user payload"),
instabot.NewIceBreaker("frequently asked question 2", "user payload"),
instabot.NewIceBreaker("frequently asked question 3", "user payload"),
instabot.NewIceBreaker("frequently asked question 4", "user payload"),
},
)
...
// Get user profile.
profile, err := bot.GetUserProfile(
context.Background(),
"instagram_user_id_you_want_to_get_profile",
)
...
// work with webhook events.
payload := []byte(`{
"object": "instagram",
"entry": [
{
"id": "",
"time": 1569262486134,
"messaging": [
{
"sender": {
"id": ""
},
"recipient": {
"id": ""
},
"timestamp": 1569262485349,
"message": {
"mid": "",
"text": ""
}
}
]
}
],
}`)
webhookEvent := new(instabot.WebhookEvent)
if err := json.Unmarshal(payload, webhookEvent); err != nil {
log.Fatal("failed to unmarshal event")
}
for _, entry := range webhookEvent.Entries {
for _, event := range entry.Messaging {
switch event.Type {
case instabot.WebhookEventTypeEcho:
case instabot.WebhookEventTypeDeleted:
log.Println(event.GetMessageDeleteEvent())
case instabot.WebhookEventTypeUnsupported:
case instabot.WebhookEventTypeMessageSeen:
log.Println(event.GetMessageSeenEvent())
case instabot.WebhookEventTypeMessageReply:
log.Println(event.GetMessageReplyEvent())
case instabot.WebhookEventTypeShare:
log.Println(event.GetMessageShareEvent())
case instabot.WebhookEventTypeReaction:
log.Println(event.GetMessageReactionEvent())
case instabot.WebhookEventTypeTextMessage:
log.Println(event.GetTextMessageEvent())
case instabot.WebhookEventTypeImageMessage:
log.Println(event.GetMediaMessageEvent())
case instabot.WebhookEventTypeAudioMessage:
log.Println(event.GetMediaMessageEvent())
case instabot.WebhookEventTypeVideoMessage:
log.Println(event.GetMediaMessageEvent())
case instabot.WebhookEventTypeFileMessage:
log.Println(event.GetMediaMessageEvent())
case instabot.WebhookEventTypeQuickReply:
log.Println(event.GetQuickReplyEvent())
case instabot.WebhookEventTypePostBack:
log.Println(event.GetPostBackEvent())
case instabot.WebhookEventTypeStoryMention:
log.Println(event.GetStoryMentionEvent())
case instabot.WebhookEventTypeStoryReply:
log.Println(event.GetStoryReplyEvent())
default:
log.Println("unexpected event")
}
}
}
...
}
```