Skip to main content

Conversation API

Credentials

In order to use the API, you will need to use the credentials. To find your credentials, sign in to the dashboard, select the organization, and then navigate to the API -> Settings section in the left sidebar. Each organization have separate unique API Key.

Using Credentials

With each request to the API, make sure to include the Organization API Key in the headers of the request. The server expects the Authorization header relating to auth:

{
  "Authorization": {your API Key}
  ...
}

There is no need to pass Bearer or Basic in the Authorization header.

Best Practices

It is generally best practice not to expose your API keys by using them from the frontend, and we highly recommend keeping your API Key in a safe place without any access for common users.

Supported protocols and ports

We only support HTTPS requests to our API with a minimum TLS v.1.2.
SMPP protocol or HTTP requests without SSL are NOT supported.

Supported ports for HTTPS requests:

  • 443
  • 2053
  • 2083
  • 2087
  • 2096
  • 8443

Requests to any other ports or with TLS v.1.1 and fewer may fail