Get Canned Messages

API will return list of canned message create by user.

Resource URL

https://Server Node Environment/index.php

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

Resource Information

Parameters Values
Resource Format JSON
Method GET
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 index - Controller method name
token REQUIRED Application Access Token
user_id REQUIRED Agent(Operator) ID

Response


{
    "result": "success",
    "language_version": 20171221061942,
    "canned_messages": [
        {
            "id": "20",
            "user_id": "5",
            "title": "Ready to help",
            "description": "Hey, I am ready to help you.",
            "created_at": "2017-10-23 08:28:29",
            "updated_at": "2017-12-06 13:44:06"
        },
        {
            "id": "15",
            "user_id": "5",
            "title": "Welcome",
            "description": "HI,your welcome.",
            "created_at": "2017-04-24 13:47:41",
            "updated_at": "2017-04-24 13:47:41"
        }
    ]
}

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.