Getting Started with Anyreach API

Introduction

REST API for the Anyreach platform.

Every endpoint is scoped to one organization. Authenticate with a bearer token and, if your token can reach more than one organization, name the one you mean with the X-Anyreach-Org header. See Authentication.

This reference is generated from the running service, so the request and response shapes here are the ones the API actually enforces.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install areach-apimatic-sdk==0.0.1

You can also view the package at: https://pypi.python.org/pypi/areach-apimatic-sdk/0.0.1

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and pytest is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt pytest

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

from anyreachapi.anyreachapi_client import AnyreachapiClient
from anyreachapi.configuration import Environment
from anyreachapi.http.auth.o_auth_2 import BearerAuthCredentials

client = AnyreachapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION
)

Environment-Based Client Initialization

from anyreachapi.anyreachapi_client import AnyreachapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = AnyreachapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Conversationattachments
• Conversationevents
• Knowledgebases
• Knowledgebasesources
• Phonenumbers
• Inboundrouting
• Agentassist
• Humanhandoff
• Emaildomains
• Emailaddresses
• Webwidgets
• Campaigncontacts
• Campaignconfigurations
• Campaignstats
• Customdata
• Evaluationruns
• Workflowtriggers
• Workflowexecutions
• Workflowcredentials
• Agents
• Conversations
• Sources
• Trunks
• Unsubscribes
• Campaigns
• Metrics
• Evaluations
• Workflows

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime