Skip to main content

Python client SDK for Sendbee Public API

Project description

 _______ _______ __   _ ______  ______  _______ _______      _______  _____  _____
 |______ |______ | \  | |     \ |_____] |______ |______      |_____| |_____]   |  
 ______| |______ |  \_| |_____/ |_____] |______ |______      |     | |       __|__

                .' '.            __
       .        .   .           (__\_
        .         .         . -{{_(|8)
          ' .  . ' ' .  . '     (__/

Sendbee Python API Client

PyPI version Build Status

GitHub issues GitHub closed issues GitHub closed pull requests

PyPI - Python Version GitHub GitHub last commit

Installation

> pip install sendbee-api

Usage

Initialization

from sendbee_api import SendbeeApi

api = SendbeeApi(
    '__your_api_key_here__', '__your_secret_key_here__',
    '__business_id_here__'
)

Fetch contacts

contacts = api.contacts([tags=['...', ...]], [search_query='...'])

for contact in contacts:
    contact.id
    contact.name
    contact.phone
    contact.email
    contact.created_at
    contact.tags

Subscribe contact

contact = api.subscribe_contact(phone='+...', [tags=['...', ...]])

contact.id
contact.name
contact.phone
contact.email
contact.created_at
contact.tags

Fetch tags

tags = api.tags([name='...'])

for tag in tags:
    tag.id
    tag.name

Create tag

tag = api.create_tag(name='...')

tag.id
tag.name

Update tag

tag = api.update_tag(id='...', name='...')

tag.id
tag.name

Delete tag

tag = api.delete_tag(id='...')

Fetch message templates

templates = api.message_templates([search_query='...'])

for template in templates:
    template.id
    template.text
    template.tags
    template.keyword
    template.language
    template.approved

Send template message

response = api.send_template_message(
    phone='+...', template_keyword='...', language='...', tags=['...', ...]
)

response.conversation_id
# save this id, and when you get sent message status requests on
# your webhook, you'll get this same id to identify the conversation

Authenticate webhook request

After you activate your webhook URL in Sendbee Dashboard, we will start sending requests on that URL depending which webhook type is linked for that webhook URL.
Every request that we make will have authorization token ih header, like this:

{
    ...
    'X-Authorization': '__auth_token_here__',
    ...
}

To authenticate requests that we make to your webhook URL, take this token from request header and check it using Sendbee API Client:

from sendbee_api import SendbeeApi

api = SendbeeApi('__your_api_key_here__', '__your_secret_key_here__')

token = '...'  # taken from the request header
if api.auth.check_auth_token(token):
    print('Weeee... Sendbee sent me the data on my webhook URL \o/ :)')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sendbee_api-0.1.0.dev1.tar.gz (10.9 kB view hashes)

Uploaded Source

Built Distribution

sendbee_api-0.1.0.dev1-py3-none-any.whl (16.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page