https://github.com/nanofuxion/kik_go_api

An unofficial kik bot api written in Go based on YassienW/kik-node-api
https://github.com/nanofuxion/kik_go_api

chatbot golang kik kik-api kikbot

Last synced: about 2 months ago
JSON representation

An unofficial kik bot api written in Go based on YassienW/kik-node-api

• Host: GitHub
• URL: https://github.com/nanofuxion/kik_go_api
• Owner: nanofuxion
• License: mit
• Created: 2020-11-11T18:40:50.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-17T19:02:46.000Z (over 1 year ago)
• Last Synced: 2024-06-20T08:06:19.293Z (6 months ago)
• Topics: chatbot, golang, kik, kik-api, kikbot
• Language: Go
• Homepage:
• Size: 15.6 KB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kik_go_api

kik_go_api is a Go package for interacting with the Kik messaging API. It allows you to build bots and clients that can send/receive messages on Kik.

The package was inspired by the [kik-node-api](https://github.com/YassienW/kik-node-api) Node.js library.

## Usage

To use kik_go_api, first create a Client instance:

```go

client := kik_go_api.Client

```

Then configure the client with your username, password, and optionally the Kik version:

```go

client.Settings("username", "password") 

// Kik version defaults to 15.25.0.22493

client.Settings("username", "password", "15.15.0.12345", "pNtboj79GGFYk9w2RbZZTxLpZUY=")  

// Custom Kik version and SHA1 hash

```

> NOTE: The Kik version defaults to 15.25.0.22493 if not provided. Only the major and minor version numbers are needed.

Next, connect the client:

```go 

messages := make(chan string)

go client.Connect(messages)

```

This will start receiving messages on the `messages` channel. 

To send messages, use the `SendMsg` method:

```go

client.SendMsg("Hello world!", "[email protected]") // Send to a user

client.SendMsg("Hello group!", "[email protected]") // Send to a group

``` 

There is also a `SendRaw` method for sending raw XML stanzas:

```go

client.SendRaw(`

    

      Hello! 

    

`)

```

### Receiving Messages

To parse incoming messages, you can pass the `msg` string from the `messages` channel to your own parsing function. 

For example, here is a basic parser from `bot.go.example`:

```go

for msg := range messages {

  if strings.Contains(msg, "type=\"chat\"") {

      // Extract JID 

      jid := extractJid(msg)  

      // Build message stanza

      stanza := buildMessageStanza("Hello!", jid) 

      // Send message

      client.SendRaw(stanza)

  }

}

func extractJid(msg string) string {

  // Use regexp to extract JID 

  return jid 

}

func buildMessageStanza(body string, to string) string {

  // Build XML stanza

  return stanza

}

```

This extracts the incoming message JID and sends a response.

You can replicate the parsing logic from other Kik API wrappers like [kik-bot-api-unofficial](https://github.com/tomer8007/kik-bot-api-unofficial) (Python) or [kik-node-api](https://github.com/YassienW/kik-node-api) (Node.js).

## Contributing

Contributions are welcome! kik_go_api is missing some features like group chat and read receipts. See the [issue tracker](https://github.com/nanofuxion/kik_go_api/issues) for details.

## License

MIT License - see [LICENSE](LICENSE) for details.