CallFire Solutions

Query Auto Reply

Follow

QUERY AUTO REPLY

This method lists the configured auto-replies associated with your account, using an optional number.

Request Parameters

ParameterDemo ValueDescriptionData Type
QueryAutoReplies   List of Autoreplies returned from query object
MaxResults Max number of results to return limited to 1000 (default: 1000) long
FirstResult Start of next result set (default: 0) long
Number E.164 11 digit number PhoneNumber

Response Parameters

ParameterDescriptionData Type
AutoReplyQueryResult List of AutoReplies returned from query  
TotalResults Results count long
AutoReply    
id Unique ID of Text Auto Reply long
Number Phone number to configure an auto reply message PhoneNumber
Keyword   string
Match   string
Message   string

Responses Status Codes

200, success

The request has been finished successfully.

400, bad request

This error code has a lot of possible causes, such as an account error, or an incorrect parameter. First of all, check that all parameters have the correct data or data type. If the error persists, contact CallFire support.

401, not authorized

The username or password has some error. Perhaps the login has expired. Make sure that you valid account.

404, not found

The ID or Number that you are trying to edit or get was not found; you should check to see if it is correct.

500, internal error

This error is not caused by the user, but is CallFire's. Please contact support.

Example: QueryAutoReplies


using RestSharp;

namespace [your-namespace]
{
    public class [your-class]
    {
        public string QueryReplies()
        {
            var client = new RestClient("https://www.callfire.com/api/1.1/rest/");
            client.Authenticator = new HttpBasicAuthenticator("YourLoginId", "password");

            var request = new RestRequest("text/auto-reply", Method.GET);
            request.AddParameter("MaxResults", "2"); 
            request.AddParameter("FirstResult", "0");

            var response = client.Execute(request);
            string content = response.Content;
            return content;
        }
    }
}

The XML returned is:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<r:ResourceList xmlns="http://api.callfire.com/data" xmlns:r="http://api.callfire.com/resource" totalResults="5">

    <AutoReply id="3552074003">

       <Number>12132042444</Number>

       <Message>Thanks for your message</Message>

    </AutoReply>

</r:ResourceList>

Have more questions? Submit a request

Comments