Introduction

Apizee and ApiRTC REST APIs enable developers to manage video chat lifecycle and integrate valuable data into other systems.

What can you do with the Apizee REST APIs?

REST APIs split into 2 categories:

ApiRTC APIs
Apizee APIs

Linked to ApiRTC platform

Linked to the Apizee platform

Manage low level communication objects

Manage Apizee SaaS solutions objects

Available endpoints:

  • /sessions

  • /conversations

  • /sms

  • /emails

  • /medias

Available endpoints:

  • /users

  • /enterprises

  • /service

  • /tickets

  • /conferences

  • /hl7

Authentication is managed by a shared endpoint: /authentication

>> Try it now

>> Get the specs

Authentication

You need to be an Apizee or ApiRTC authenticated user to use the APIs.

Platform
Access to ApiRTC APIs
Access to Apizee APIs

Account on https://cloud.apirtc.com

x

Account on https://cloud.apizee.com

x

x

👉Create an account on the ApiRTC Console or on the Apizee plaform depending on what endpoint you need.

👉Use the /authentication endpoint providing your username and password to get a token in return (see Bearer Authentication).

👉Include the token in the Authorization header of requests:

Authorization: Bearer <token>

Example of use:

curl -X 'POST' 'https://cloud.apizee.com/api/token?grant_type=password&username=test%40apizee.com&password=xxYY1122' 
    -H 'accept: application/JSON' 
    -d 

Response

{
    "access_token": "xyzaaa-c900-4dd2-8192-12345678",
    "created_at": "2023-07-12T15:22:04+00:00",
    "expires_in": 86400
}

Compliant with the OpenAPI Standards

ApiRTC APIs are compliant with the OpenAPI Standards.

Webhooks

Design a two-way integration by enabling ApiRTC to push events to your systems.

👉 Read more about Webhooks

Last updated