Transfer Commands¶

Note

Transfer Commands are only respected by the WebChat device at this time. Sending transfers to other devices will be ignored.

Create¶

Creates a Transfer Command.

POST /api/v1/commands/transfers/{hubId}

Headers

Header	Description
Authorization	Bearer `your portal access token`
Content-Type	`application/json`

Url Segments

Segment	Description
hubId	The Hub id to create commands for.

Request Properties

Property	Mandatory	Description
name	Yes	Unique command name per Hub.
description	No	Command description.
url	Yes	Command url.
linkDescription	Yes	The description used for the link anchor on the WebChat device.
mountDelay	No	Amount of in milliseconds before mounting occurs. Default is 0, if no value supplied. mountDelay < 0, will not mount the WebChat mountDelay = 0, will immediately mount the WebChat

Example Request Body

{
    "name": "new cool command",
    "description": "Description for command",
    "url": "https://mysite.io",
    "linkDescription": "Click here to be transferred",
    "mountDelay": 1000
}

Response : 200 (OK)

{
    "commandId": "5a0623b0-d51a-4b3c-ace1-0175e34fae2f",
    "hubId": "00000000-0000-0000-0000-0000000000a1",
    "name": "new cool command",
    "description": "Description for command",
    "url": "https://mysite.io",
    "linkDescription": "Click here to be transferred",
    "mountDelay": 1000
}

HTTP Status	Description
200	OK response. The body of the response will include the data requested.
400	Bad request. The body of the response will have more info.
401	Unauthorized. Token is invalid.
403	Forbidden. Access to the requested resource is forbidden.
408	Timed out. The request timed out.
429	Too many requests. API usage limit has been reached.
500	Internal server error. There was an internal issue with the service.
503	Service unavailable. The service is unavailable.

Update¶

Updates a Transfer Command.

PUT /api/v1/commands/transfers/{commandId}

Headers

Header	Description
Authorization	Bearer `your portal access token`
Content-Type	`application/json`

Url Segments

Segment	Description
commandId	The command id affected.

Request Properties

Property	Mandatory	Description
name	No	Unique command name per Hub.
description	No	Command description.
url	No	Command url.
linkDescription	Yes	The description used for the link anchor on the WebChat device.
mountDelay	No	Amount of in milliseconds before mounting occurs. Default is 0, if no value supplied. mountDelay < 0, will not mount the WebChat mountDelay = 0, will immediately mount the WebChat

Example Request Body

{
    "name": "new cool command",
    "description": "Description for command",
    "url": "https://mysite.io",
    "linkDescription": "Click here to be transferred",
    "mountDelay": 1000
}

Response : 200 (OK)

{
    "commandId": "5a0623b0-d51a-4b3c-ace1-0175e34fae2f",
    "hubId": "00000000-0000-0000-0000-0000000000a1",
    "name": "new cool command",
    "description": "Description for command",
    "url": "https://mysite.io",
    "linkDescription": "Click here to be transferred",
    "mountDelay": 1000
}

HTTP Status	Description
200	OK response. The body of the response will include the data requested.
400	Bad request. The body of the response will have more info.
401	Unauthorized. Token is invalid.
403	Forbidden. Access to the requested resource is forbidden.
404	Not found. Resource not found.
408	Timed out. The request timed out.
429	Too many requests. API usage limit has been reached.
500	Internal server error. There was an internal issue with the service.
503	Service unavailable. The service is unavailable.

Delete¶

Deletes a Transfer Command.

DELETE /api/v1/commands/transfers/{commandId}

Headers

Header	Description
Authorization	Bearer `your portal access token`
Content-Type	`application/json`

Url Segments

Segment	Description
commandId	The transfer command id.

Response : 200 (OK)

HTTP Status	Description
200	OK response. The body of the response will include the data requested.
401	Unauthorized. Token is invalid.
403	Forbidden. Access to the requested resource is forbidden.
404	Not found. Resource not found.
408	Timed out. The request timed out.
429	Too many requests. API usage limit has been reached.
500	Internal server error. There was an internal issue with the service.
503	Service unavailable. The service is unavailable.

Get¶

Gets a Transfer Command.

GET /api/v1/commands/transfers/{commandId}

Headers

Header	Description
Authorization	Bearer `your portal access token`
Content-Type	`application/json`

Url Segments

Segment	Description
commandId	The transfer command id to get.

Response : 200 (OK)

{
    "commandId": "5a0623b0-d51a-4b3c-ace1-0175e34fae2f",
    "hubId": "00000000-0000-0000-0000-0000000000a1",
    "name": "new cool command",
    "description": "Description for command",
    "url": "https://mysite.io",
    "linkDescription": "Click here to be transferred",
    "mountDelay": 1000
}

HTTP Status	Description
200	OK response. The body of the response will include the data requested.
401	Unauthorized. Token is invalid.
403	Forbidden. Access to the requested resource is forbidden.
404	Not found. Resource not found.
408	Timed out. The request timed out.
429	Too many requests. API usage limit has been reached.
500	Internal server error. There was an internal issue with the service.
503	Service unavailable. The service is unavailable.

Get Collection¶

Gets a list of Transfer Commands.

GET /api/v1/commands/transfers/hub/{hubId}

Headers

Header	Description
Authorization	Bearer `your portal access token`
Content-Type	`application/json`

Url Segments

Segment	Description
hubId	The Hub id to get transfer commands for.

Response : 200 (OK)

[
    {
        "commandId": "5a0623b0-d51a-4b3c-ace1-0175e34fae2f",
        "hubId": "00000000-0000-0000-0000-0000000000a1",
        "name": "new command 2",
        "description": "Description for command",
        "url": "https://mysite.io",
        "linkDescription": "Click here to be transferred",
        "mountDelay": 1000
    }
]

HTTP Status	Description
200	OK response. The body of the response will include the data requested.
400	Bad request. The body of the response will have more info.
401	Unauthorized. Token is invalid.
403	Forbidden. Access to the requested resource is forbidden.
408	Timed out. The request timed out.
429	Too many requests. API usage limit has been reached.
500	Internal server error. There was an internal issue with the service.
503	Service unavailable. The service is unavailable.