Skip to content

Quick Support

On this page, you will find descriptions of the API methods intended for working with invitations from the Quick Support section.

Invitation List

To get a list of open invitations from the Quick Support section, use the support/list method.

Request:
GET /v1/support/list
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl "https://api.getscreen.me/v1/support/list" \
  -H "X-Api-Key: YOUR_API_KEY"

No params.

Response:
Example Response
Response Data
{
    "remain":100,
    "data":[ {
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.getscreen.me/invite/408080316",
        "connect_url":"https://https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    } ]
}

Connection record data:

Name Type Description
id number Internal system connection ID
status number Connection status. Possible values:
  • 0 - New connection, waiting for client to join
  • 1 - Client joined, waiting for operator to join
  • 2 - Active connection, all members joined
  • 3 - Closed connection
create_time unixtime Connection creation date and time
invite_code string Invitation code
invite_url string Invitation URL
connect_url string Operator connection URL
client_name string Client name
client_os string Operating system. Possible values: win, mac, linux and android

ℹ The field is filled after the client joins
client_preview_url string Client desktop thumbnail

ℹ The field is filled after the client joins

Additional info:

Name Type Description
remain number Number of remaining connections within the rate plan

Invitation Info

To get the info about a specific invitation, use the support/info method.

Request:
GET /v1/support/info
  ?connection_id=<number>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -G "https://api.getscreen.me/v1/support/info" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \
Parameter Type Value
connection_id number Internal system invitation ID
Response:
Example Response
Response Data
{
    "data":{
        "id":328,
        "status":2,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.getscreen.me/invite/408080316",
        "connect_url":"https://https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"win",
        "client_preview_url":"https://getscreen.me/preview/f90d07668bccd418a5a8922f2ee455f1eb004c2bbeb5f9fe05ed6970c3389114Zl5PgknTWlU0fWBe4b9YoHNvRlD5Iwl5.png"
    }
}
Name Type Description
id number Internal system connection ID
status number Connection status. Possible values:
  • 0 - New connection, waiting for client to join
  • 1 - Client joined, waiting for operator to join
  • 2 - Active connection, all members joined
  • 3 - Closed connection
create_time unixtime Connection creation date and time
invite_code string Invitation code
invite_url string Invitation URL
connect_url string Operator connection URL
client_name string Client name
client_os string Operating system. Possible values: win, mac, linux and android

ℹ The field is filled after the client joins
client_preview_url string Client desktop thumbnail

ℹ The field is filled after the client joins

Create Invitation

To create an invitation and scheduled connection for Quick Support, use the support/create method.

Request:
POST /v1/support/create
  ?client_name=<string>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.getscreen.me/v1/support/create" \
  --data-urlencode "client_name=<string>" \
  -H "X-Api-Key: YOUR_API_KEY"
Parameter Type Value
client_name string Client name (only visible to you). Optional parameter.
Response:
Example Response
Response Data
{
    "data":{
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.getscreen.me/invite/408080316",
        "connect_url":"https://https://go.getscreen.me/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    }
}
Name Type Description
id number Internal system connection ID
status number Connection status. Possible values:
  • 0 - New connection, waiting for client to join
  • 1 - Client joined, waiting for operator to join
  • 2 - Active connection, all members joined
  • 3 - Closed connection
create_time unixtime Connection creation date and time
invite_code string Invitation code
invite_url string Invitation URL
connect_url string Operator connection URL
client_name string Client name
client_os string Operating system. Possible values: win, mac, linux and android

ℹ The field is filled after the client joins
client_preview_url string Client desktop thumbnail

ℹ The field is filled after the client joins

Change Invitation Property

To change some property of a invitation, you can use the support/update method.

Optional Fields

You do not have to list all properties in the query. Only the ones you specify will be changed. See the parameters below for a list of fields available for updating.

Request:
POST /v1/agents/update
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

{
  "connection_id": <number>,
  "name": <string>
}

curl -X POST "https://api.getscreen.me/v1/agents/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "connection_id": <number>,
    "name": <string>
  }'
Parameter Type Value
connection_id number Internal system invitation ID
name string Customer Name
Example Response
Response Data
{
    "status": 0,
}
Name Type Description
number status Result status. Possible values:
  • 0 - Update completed successfully
  • 4 - Internal server error

Get Connection Link

To connect to the invitation with API, you need to get a one-time link with the support/connect method.

Link Expiration Time

The link expires right after its first use. You need to get one each time you want to connect.

Request:
POST /v1/support/connect
  ?connection_id=<number>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -X POST "https://api.getscreen.me/v1/agents/connect?connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"
Parameter Type Value
connection_id number Internal system invitation ID
video bool Manual control of video recording on/off (optional)
Response:
Example Response
Response Data
{
    "data":{
        "url": "https://https://go.getscreen.me/?connect=20177&amp;llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&amp;s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}
Name Type Description
url string Connection URL

Add the Connection Button to Your Dashboard

Learn how to integrate a connection link into your system in the Integrating Remote Access into Your System guide.

Close Invitation

To close a invitation, use the support/close method.

Request:
POST /v1/support/close
  ?connection_id=<number>
Host: https://api.getscreen.me
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.getscreen.me/v1/support/close" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"
Parameter Type Value
connection_id number Internal system invitation ID
Response:

The response will be returned empty. To analyze the command execution, use only HTTP response code.