Create a session

This API allows you to create a remote support or screen sharing session.

POST /api/v2/session

OAuth Scope

ZohoAssist.sessionapi.CREATE

Query Params

Parameters
Description
customer_email
Optional
Customer Email to whom the join invitation is to be sent.
type
Optional
Default value will be rs. Allowed Values [rs | dm], where rs is Remote Support and dm is Screen Sharing.

Create a session

Copiedcurl --location --request POST 'https://assist.zoho.com/api/v2/session?customer_email=john@zylker.com&type=rs' \
--header 'Authorization: Zoho-oauthtoken {access_token}'

CopiedHTTP/1.1 200 OK

For Remote Support,
{
  "resource_type": "session",
  "representation": {
    "customer_url": "https://assist.zoho.com/join?role=A&key={session_key}&email=john%40zylker.com",
    "authkey": {
      auth_key
    },
    "technician_url": "https://assist.zoho.com/assist-start?key={session_key}&viewer=html&customer=john%40zylker.com&x-com-zoho-assist-orgid={zsoid}",
    "session_id": "24********",
    "authtype": "0"
  }
}
For Screen Sharing,
{
  "resource_type": "session",
  "representation": {
    "customer_url": "https://assist.zoho.com/demo-viewer.do?key={session_key}&d=5a21cc*******************&customer=john%40zylker.com",
    "authkey": {
      auth_key
    },
    "technician_url": "https://assist.zoho.com/presenter?key={session_key}&customer=john%40zylker.com&x-com-zoho-assist-orgid={zsoid}",
    "session_id": "67**********",
    "authtype": "0"
  }
}