Canned responses

You can use the API to get or set canned response information.

The Canned respose model

Field	Type	Description
id	String	The unique identifier for the canned respose which is given by Pingstreams.
title	String	The canned respose title.
text	String	The canned respose content
attributes	Object	The custom attributes which are set for the canned respose.
createdAt	String	The time (ISO-8601 date string) when the canned respose was created.
updatedAt	String	The time (ISO-8601 date string) when the canned respose was updated.
createdBy	String	The unique identifier of the row creator
id_project	String	The unique identifier of the project

Get all canned responses

GET https://api.pingstreams.com/v3/:project_id/canned

Allows an account to list all the canned responses.

Path Parameters

Parameter	Type	Description
project_id	string	the Project Id is a unique code assigned to your project when you create it in Pingstreams.

Query Parameters

Parameter	Type	Description
sortField	string	what field to sort the results by. Default field is createdAt
direction	string	sort direction: 1 or -1. Return the results in ascending (1) or descending (-1) order. defaults to desc
page	number	what page of results to fetch. defaults to first page.

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent

Response

[
{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}
]

Get a canned respose by id

GET https://api.pingstreams.com/v3/:project_id/canned/:id

Path Parameters

Parameter	Type	Description
id	string	the canned identifier
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Response

{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

Delete a canned response by id

DELETE https://api.pingstreams.com/v3/:project_id/canned/:id

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams
id	string	The id is the canned response indentifier.

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent

Response

{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

Create a new canned response

POST https://api.pingstreams.com/v3/:project_id/canned

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Request Body

Field	Type	Description
title	string	the canned response title
text	string	the canned response content
attributes	object	The canned response custom attributes

Response

{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",
"createdAt":"2020-03-10T16:35:20.458Z",
"updatedAt":"2020-03-10T16:35:20.458Z",
"__v":0
}

Update a canned response by id

PUT https://api.pingstreams.com/v3/:project_id/canned/:id

Path Parameters

Parameter	Type	Description
project_id	string	The project_id is a unique code assigned to your project when you create it in Pingstreams
id	string	The id is the canned response indentifier.

Headers

Header	Type	Description
Authorization	string	Authorization token. Basic Auth or JWT. Minumun role: agent
Content-Type	string	use “application/json” value

Request Body

Field	Type	Description
title	string	the canned response title
text	string	the canned response content
attributes	object	The canned response custom attributes

Response

{
"status":100,
"_id":"5e67c1c89d86fa001755ed90",
"title":"howcanhelpyou",
"text":"Hi $recipient_name my name is $agent_name how can I help you?",
"id_project":"5e5d40b2bd0a9b00179ff3cd",
"createdBy":"5e09d16d4d36110017506d7f",