Bevatel Business Chat Developer API

Bevatel Business Chat Developer API enables seamlessly integrate messaging capabilities into the platform.

API follow RESTful conventions and HTTP response codes as much as possible, and uses common methods like GET, POST, PUT, and DELETE for operations. The request and response bodies are encoded in JSON.

Authentication

An API Access Token with Account ID are used to authenticate the requests. You can view your access token at the end of your profile page.
The authentication is passed via api_account_id and api_access_token headers.

Rate Limits

Name	Path	req/sec
Create or update a contact	/developer/api/v1/contacts/{id}	5
Send messages	/developer/api/v1/messages	10

Contacts

create or update your account contacts

POSTCreate a contact

https://chat.bevatel.com/developer/api/v1/contacts

HEADERS

api_account_id

•••••••

api_access_token

•••••••

application/json

Bodyraw (json)

json

{
    "name": "New Contact",
    "email": "new_contact@example.com",
    "phone_number": "+966555555555",
    "custom_attributes": {
        "type": "vip"
    },
    "labels": [
        "api",
        "testing"
    ]
}

Example Request

curl

curl --location 'https://chat.bevatel.com/developer/api/v1/contacts' \
--header 'api_account_id: •••••••' \
--header 'api_access_token: •••••••' \
--header 'Accept: application/json' \
--data-raw '{
    "name": "New Contact",
    "email": "new_contact@example.com",
    "phone_number": "+966555555555",
    "custom_attributes": {
        "type": "vip"
    },
    "labels": [
        "api",
        "testing"
    ]
}'

201 Created

Example Response

json

{
  "message": "contact created successfully",
  "data": {
    "additional_attributes": {},
    "availability_status": "offline",
    "email": "new_contact@example.com",
    "id": 161,
    "name": "New Contact",
    "phone_number": "+966555555555",
    "identifier": null,
    "thumbnail": "",
    "custom_attributes": {
      "type": "vip"
    },
    "created_at": 1691053318,
    "labels": [
      "api",
      "testing"
    ],
    "blocked": false
  }
}

cache-control

no-store, must-revalidate, private, max-age=0

content-length

340

content-type

application/json; charset=utf-8

PATCHUpdate a contact

https://chat.bevatel.com/developer/api/v1/contacts/161

HEADERS

api_account_id

•••••••

api_access_token

•••••••

application/json

Bodyraw (json)

json

{
    "name": "New Contactos",
    "email": "new_contact@example.com",
    "phone_number": "+966555555555",
    "custom_attributes": {
        "type": "vip"
    },
    "labels": [
        "api",
        "testing"
    ]
}

Example Request

curl

curl --location --request PATCH 'https://chat.bevatel.com/developer/api/v1/contacts/160' \
--header 'api_account_id: •••••••' \
--header 'api_access_token: •••••••' \
--data-raw '{
    "name": "New Contactos",
    "email": "new_contact@example.com",
    "phone_number": "+966555555555",
    "custom_attributes": {
        "type": "vip"
    },
    "labels": [
        "api",
        "testing"
    ]
}'

200 OK

Example Response

json

{
  "message": "contact updated successfully",
  "data": {
    "additional_attributes": {},
    "availability_status": "offline",
    "email": "new_contact@example.com",
    "id": 160,
    "name": "New Contactos",
    "phone_number": "+966555555555",
    "identifier": null,
    "thumbnail": "",
    "custom_attributes": {
      "type": "vip"
    },
    "created_at": 1691053089,
    "labels": [
      "api",
      "testing"
    ],
    "blocked": false
  }
}

cache-control

no-store, must-revalidate, private, max-age=0

content-length

342

content-type

application/json; charset=utf-8

GETlist account contacts

https://chat.bevatel.com/api/v1/accounts/{{account_id}}/contacts?include_contact_inboxes=true&page=1&sort=name

to get all contacts for specific account account_id

HEADERS

api_access_token

•••••••

access token returned from login

PARAMS

include_contact_inboxes

true

if you want to retrieve inboxes with the contacts or not

page

used for pagination

sort

name

Example Request

curl

curl --location -g --request POST 'https://chat.bevatel.com/api/v1/accounts/{{account_id}}/contacts?include_contact_inboxes=true&page=1&sort=name' \
--header 'api_access_token: •••••••' \
--header 'Content-Type: application/json' \
--data ''

404 Not Found

Example Response

json

{
  "error": "Resource could not be found"
}

X-Frame-Options

ALLOWALL

Content-Type

application/json; charset=utf-8

Cache-Control

no-cache

X-Request-Id

14c3f3c3-a8e0-42b1-9ec0-d900b0e857ea

X-Runtime

0.010391

vary

Origin

Set-Cookie

__profilin=p%3Dt; path=/; HttpOnly; SameSite=Lax

Transfer-Encoding

chunked