Add Or Update A Canned Message

API will add or update a canned message for agent.

Resource URL

https://Server Node Environment/index.php

Example : https://api.yourdomain.com/index.php

Resource Information

Parameters Values
Resource Format JSON
Method POST
Requires authentication? Yes

Request

GET Params

Parameters Mandatory Description
[Request parameters]
d REQUIRED api - Controller directory name
c REQUIRED canned_messages - Controller name
m REQUIRED save - Controller method name
token REQUIRED Application Access Token

POST Params

Parameters Mandatory Description
[Request parameters]
user_id REQUIRED Agent or Operator ID
title REQUIRED Canned Title
description REQUIRED Message content
id OPTIONAL Canned Message ID (If you pass id message will be update)

Response on Add Message


{
    "result": "success",
    "language_version": 20171221061942,
    "is_new": true,
    "created": {
        "id": "22",
        "user_id": "5",
        "title": "title",
        "description": "This is my new message.",
        "created_at": "2018-05-29 08:37:32",
        "updated_at": "2018-05-29 08:37:32"
    },
    "message": "Canned message has been saved successfully."
}

Response on Update Message


{
    "result": "success",
    "language_version": 20171221061942,
    "is_new": false,
    "message": "Canned message has been saved successfully."
}

Messages returned

HTTP STATUS CODE Description MESSAGE BODY
200 Successfully Return Return Json data.
200 Authorization Error {"result":"failed","error":"Invalid access token or Token has been expired."}
400 Request is malformed {"error": "invalid_request", "error_description": "description"}
403 Forbidden Directory access is forbidden.
404 Resource Not found The page you requested was not found.