SnapCall

Use the SnapCall API to create [Instant](https://www.snapcall.io/instant) or [Assist](https://www.snapcall.io/assist) video streams.

Create an account [here](https://app.snapcall.io) to get your access token.

API Reference

Introduction

Security and authentication

Rate limits

SnapCall Assist revolutionizes customer support with its video recording feature for efficient problem explanation.

Clip

Stream object parameters :

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| company_id | integer | workspace id of your SnapCall account. |
| name | string | Name your stream |
| type | string | assist |
| origin | string | Give an origin label |
| short_url | Boolean | shrink the original url |

Create clip

Say it with video - easly record and send issue to support team.

Call

Stream object parameters :

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| company_id | integer | workspace id of your SnapCall account. |
| name | string | Name your stream |
| type | string | instant |
| origin | string | Give an origin label |
| short_url | Boolean | shrink the original url |

Create instant stream

Retrieves the details of a SnapCall stream (instant or assist) that has previously been created. Supply the unique stream token that was returned from your previous create request, and SnapCall will return the corresponding stream informations.

Data

List Streams

Get Stream

Close/Archive Stream

Skills

Library

List Library

Get Library Video

Webhooks

List webhooks

Create webhook

Show webhook

Update webhook

Delete webhook

Events types

SnapCall API

Production

MCP server

Sandbox

The SnapCall API is used to create <a href="https://www.snapcall.io/instant" target="_self">Clip</a> or <a href="https://www.snapcall.io/assist" target="_self">Call</a> video streams along with retrieving the results of the media capture.Create an account <a href="https://app.snapcall.io" target="_self">here</a> to get your api key.

 video streams along with retrieving the results of the media capture.

This is the reference documentation for the SnapCall API.

This is the reference documentation for the SnapCall API.

SnapCall Clip revolutionizes customer support with its video recording feature for efficient problem explanation.

SnapCall Clip revolutionizes customer support with its video recording feature for efficient problem explanation.

Effortlessly connect with your clients in real-time. No installation necessary — just share a link for an audio or video call and start the conversation instantly.

Effortlessly connect with your clients in real-time. No installation necessary — just share a link for an audio or video call and start the conversation instantly.

Retrieves the details of a SnapCall stream (instant or assist) that has previously been created. Supply the unique stream token that was returned from your previous create request, and SnapCall will return the corresponding stream informations.

Authorization

company_id

limit

order

data

items_count

{
  "data": [
    {
      "token": "eab076eb-c2ee-4156-b8b3-eae052f3e128",
      "bid": {},
      "company_id": 6412,
      "call_id": 2316700,
      "name": "Ticket #2011",
      "origin": "zendesk",
      "type": "assist",
      "streamer_instance": "str_1",
      "user_limit": 4,
      "context": {
        "externalId": "2011",
        "externalIdUrl": "https://d3v-snapcalldemo.zendesk.com/agent/tickets/2011"
      },
      "created_at": "2023-05-31T21:40:52.000Z",
      "updated_at": "2023-05-31T21:40:58.000Z",
      "expired_at": {},
      "id": 188451,
      "user_id": 6426,
      "team_id": {},
      "team": {},
      "button": null,
      "user": {
          "id": 6426,
          "name": "John Doe (from SnapCall)",
          "email": "demo@snapcall.io",
          "settings": {
            "language": "en",
            "stream": {
              "microphoneEnabled": true,
              "cameraEnabled": true,
              "autoJoin": true,
              "newTab": true
            },
            "avatar_url": "https://stream-assets.snapcall.io/user_profile/6b6860d9-4163-444e-9515-6c684e38d026.jpg"
          },
          "role": {
            "id": 1,
            "name": "owner"
          }
        }
        "events": [
          {
            "id": 791369,
            "stream_id": 188451,
            "type": "capture",
            "peer_id": "20451a41-ed02-4dd3-bd86-7e2496267a58",
            "role": "customer",
            "data": {
              "from": "recorder",
              "type": "video",
              "s3Asset": "6412/2316700/recorder/4391e6eb-560a-4d05-a49f-822808e9ed3e.webm",
              "summary": {
                "text": "- Le client a un **problème** sur son enceinte Devialet Mania après qu'un ami ait renversé un **liquide** dessus.\n- Le client veut savoir si il est possible de **réparer** ou **changer** le **tissu** ou de **remplacer** l'enceinte.\n- La demande a été faite pour un **support client**.\n- Le client est reconnaissant et souhaite une **très bonne journée**.",
                "status": "completed"
              },
              "thumbnail": {
                "s3Asset": "snapshots/e559ebd2-cdd4-4963-a6a1-30e23121f317.jpeg",
                "s3Bucket": "snapcallstreamassets-production"
              },
              "assemblyTranscriptId": "6sa3cn0y94-3b1b-4269-8c5d-16c95e665a12"
            },
            "emitted_at": "2023-05-31T21:41:34.000Z",
            "created_at": "2023-05-31T21:41:34.000Z"
          }
        ],
      }
    ]
  "items_count": 1,
  "has_next_page": false
}

token

user_id

type

s3_key

duration

name

description

created_at

updated_at

thumbnail_url

A webhook sends an HTTP request to a specified URL when an event occurs in SnapCall. For example, you can configure a webhook to trigger when an AI skill finishes processing media.

A webhook sends an HTTP request to a specified URL when an event occurs in SnapCall. For example, you can configure a webhook to trigger when an AI skill finishes processing media.

Sections