API Reference

API Reference

Use the SnapCall API to create Instant or Assist video streams.

Create an account here to get your api key.

Base URL

Language Box

Assist

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

Create assist stream

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

HEADER PARAMETERS

Authorizationstring Required

PATH PARAMETERS

company_idstring Required

BODY PARAMETERS

typestring
short_urlboolean

Responses

201
Object

Response attributes

tokenstring
bidobject
user_idnumber
user_limitnumber
streamer_instancestring
company_idnumber
typestring
idnumber
short_urlstring
1

Instant

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.

Create instant stream

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

HEADER PARAMETERS

Authorizationstring Required

PATH PARAMETERS

company_idstring Required

BODY PARAMETERS

typestring
short_urlboolean

Responses

201
Object

Response attributes

tokenstring
bidobject
user_idnumber
user_limitnumber
streamer_instancestring
company_idnumber
typestring
idnumber
short_urlstring
1

Datas

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.

Retrieve a stream

HEADER PARAMETERS

Authorizationstring Required

PATH PARAMETERS

company_idstring Required
tokenstring Required

Responses
Expand all

200
Object

Response attributes

tokenstring
bidobject
company_idnumber
call_idnumber
namestring
originstring
typestring
streamer_instancestring
user_limitnumber
contextobject
child attributes
externalIdstring
externalIdUrlstring
created_atstring
updated_atstring
expired_atobject
idnumber
user_idnumber
team_idobject
teamobject
eventsarray
child attributes
idnumber
stream_idnumber
typestring
peer_idstring
rolestring
dataobject
child attributes
fromstring
typestring
s3Assetstring
summaryobject
child attributes
textstring
statusstring
thumbnailobject
child attributes
s3Assetstring
s3Bucketstring
assemblyTranscriptIdstring
emitted_atstring
created_atstring
userobject
child attributes
idnumber
namestring
emailstring
settingsobject
child attributes
languagestring
streamobject
child attributes
microphoneEnabledboolean
cameraEnabledboolean
autoJoinboolean
newTabboolean
avatar_urlstring
roleobject
child attributes
idnumber
namestring
1